[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorinview":145},[4,10,16,20,24,28,32,36,40,44,48,52,56,60,64,69,73,78,82,86,90,94,98,102,106,110,114,117,120,124,127,131,134,138,141],{"path":5,"title":6,"description":7,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide","Getting started","Shaders is a library of GPU effect components for Vue, React, Svelte, Solid, JavaScript and Framer, with a design editor for building with them.","code",null,{"path":11,"title":12,"description":13,"category":8,"exclude":14,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",[15],"js",{"path":17,"title":18,"description":19,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":21,"title":22,"description":23,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":25,"title":26,"description":27,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fprops-reactivity","Props and reactivity","Bind props to your framework's state so effects update when it changes, and animate props with an animation library.",{"path":29,"title":30,"description":31,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":33,"title":34,"description":35,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Flayout-positioning","Layout and positioning","Size and place a shader in your page with CSS, as a background, a fill, or an inline block.",{"path":37,"title":38,"description":39,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in % or px units.",{"path":41,"title":42,"description":43,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fshape-effects","Shape effects","Pick the 2D, 3D or custom SVG shape that Glass, Neon, Emboss and other shape effects draw inside.",{"path":45,"title":46,"description":47,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcolor-space","Color space","Match colors to your design tool with the output color space, and keep bright layers from clipping with tone mapping.",{"path":49,"title":50,"description":51,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fhooks-events","Hooks and events","Run code when an effect is ready to show, and show a fallback when the GPU can't run it.",{"path":53,"title":54,"description":55,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":57,"title":58,"description":59,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcustom-shaders","Custom components","Write your own component in TypeScript, use it like any component in the library, and write WGSL by hand when you need to.",{"path":61,"title":62,"description":63,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":65,"title":66,"description":67,"category":68,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fmcp","Shaders MCP","Connect your AI coding agent to Shaders so it can find, install and edit effects in your codebase.","workflows",{"path":70,"title":71,"description":72,"category":68,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install shaders and presets into your codebase as component files, and keep them in sync with the design editor.",{"path":74,"title":75,"description":76,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fquick-tour-of-the-design-editor","Quick tour of the design editor","A short walkthrough of the full Shaders workflow, from designing on the infinite canvas to exporting code.","editor",{"path":79,"title":80,"description":81,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fintro-to-the-interface","Intro to the interface","A tour of the design editor interface: the canvas, layers, the Properties panel, and the ways to share and export.",{"path":83,"title":84,"description":85,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcomposing-your-first-shader-effect","Composing your first shader effect","Building a first shader effect in the design editor by stacking and nesting components as layers.",{"path":87,"title":88,"description":89,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":91,"title":92,"description":93,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdynamic-prop-mapping","Dynamic prop mapping","Turning static props into dynamic ones in the design editor: mapping one layer's output into another's prop, following the cursor, or animating automatically.",{"path":95,"title":96,"description":97,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fcustom-media-and-transformations","Custom media and transformations","Uploading images, videos, and SVG files to the media gallery, adding them to a composition, and placing them with transformations.",{"path":99,"title":100,"description":101,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Finstalling-a-shader-via-mcp","Installing a shader via MCP","Installing a shader from the design editor into a hero section with the Shaders MCP.",{"path":103,"title":104,"description":105,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fexploring-shape-effects","Exploring shape effects","Applying shape effects such as liquid glass, liquid metal, and glowing edges to built-in shapes and your own SVG.",{"path":107,"title":108,"description":109,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":111,"title":112,"description":113,"category":77,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"path":115,"title":12,"description":116,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fjs\u002Fquickstart","Install Shaders without a framework, render your first effect on a canvas, and update props at runtime.",{"path":118,"title":12,"description":119,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fquickstart","Install Shaders in a React app, render your first effect, and drive a prop from state.",{"path":121,"title":122,"description":123,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Freact\u002Fssr","Next.js and SSR","Render Shaders in Next.js and other React SSR apps by keeping each shader on the client.",{"path":125,"title":12,"description":126,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fquickstart","Install Shaders in a Solid app, render your first effect, and drive a prop from a signal.",{"path":128,"title":129,"description":130,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsolid\u002Fssr","SolidStart and SSR","Render Shaders in SolidStart and other Solid SSR apps by keeping each shader on the client.",{"path":132,"title":12,"description":133,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fquickstart","Install Shaders in a Svelte app, render your first effect, and drive a prop from state.",{"path":135,"title":136,"description":137,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fsvelte\u002Fssr","SvelteKit and SSR","Render Shaders in SvelteKit and other Svelte SSR apps, where each shader already waits for the browser.",{"path":139,"title":12,"description":140,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fquickstart","Install Shaders in a Vue app, render your first effect, and drive a prop from a ref.",{"path":142,"title":143,"description":144,"category":8,"exclude":9,"forceFramework":9},"\u002Fdocs\u002Fguide\u002Fvue\u002Fssr","Nuxt and SSR","Render Shaders in Nuxt and other Vue SSR apps by keeping each shader on the client.",{"id":146,"title":147,"body":148,"categoryId":443,"categorySlug":444,"categoryTitle":445,"curated":446,"description":158,"editUrl":9,"extension":447,"group":448,"groupTitle":449,"kind":450,"meta":451,"navigation":452,"path":453,"seo":454,"sourceUrl":455,"stem":456,"wordCount":9,"__hash__":457},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F18.force-cursorinview.md","force.cursorInView",{"type":149,"value":150,"toc":438},"minimark",[151,155,159,258,272,277,328,332,384,388,434],[152,153,147],"h1",{"id":154},"forcecursorinview",[156,157,158],"p",{},"The cursor on an image relief, applied where each particle appears on screen.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","force.cursorInView(\n  layout: ReliefLayout,\n  cfg: {perspK: number},\n): (homeW: d.v2f, off: d.v2f, z: number) => d.v3f\n","ts","",[8,167,168,184,190,196],{"__ignoreMap":165},[169,170,173,177,181],"span",{"class":171,"line":172},"line",1,[169,174,176],{"class":175},"s95oV","force.",[169,178,180],{"class":179},"svObZ","cursorInView",[169,182,183],{"class":175},"(\n",[169,185,187],{"class":171,"line":186},2,[169,188,189],{"class":175},"  layout: ReliefLayout,\n",[169,191,193],{"class":171,"line":192},3,[169,194,195],{"class":175},"  cfg: {perspK: number},\n",[169,197,199,202,206,209,213,215,218,221,224,227,230,232,234,236,238,240,243,245,249,252,255],{"class":171,"line":198},4,[169,200,201],{"class":175},")",[169,203,205],{"class":204},"snl16",":",[169,207,208],{"class":175}," (",[169,210,212],{"class":211},"s9osk","homeW",[169,214,205],{"class":204},[169,216,217],{"class":179}," d",[169,219,220],{"class":175},".",[169,222,223],{"class":179},"v2f",[169,225,226],{"class":175},", ",[169,228,229],{"class":211},"off",[169,231,205],{"class":204},[169,233,217],{"class":179},[169,235,220],{"class":175},[169,237,223],{"class":179},[169,239,226],{"class":175},[169,241,242],{"class":211},"z",[169,244,205],{"class":204},[169,246,248],{"class":247},"sDLfK"," number",[169,250,251],{"class":175},") ",[169,253,254],{"class":204},"=>",[169,256,257],{"class":175}," d.v3f\n",[156,259,260,261,264,265,268,269,220],{},"Import ",[8,262,263],{},"sim"," from ",[8,266,267],{},"shaders\u002Fstd"," and use ",[8,270,271],{},"sim.agentForces.force.cursorInView",[273,274,276],"h2",{"id":275},"parameters","Parameters",[278,279,280,296],"table",{},[281,282,283],"thead",{},[284,285,286,290,293],"tr",{},[287,288,289],"th",{},"Name",[287,291,292],{},"Type",[287,294,295],{},"Notes",[297,298,299,314],"tbody",{},[284,300,301,307,312],{},[302,303,304],"td",{},[8,305,306],{},"layout",[302,308,309],{},[8,310,311],{},"ReliefLayout",[302,313],{},[284,315,316,321,326],{},[302,317,318],{},[8,319,320],{},"cfg",[302,322,323],{},[8,324,325],{},"{perspK: number}",[302,327],{},[273,329,331],{"id":330},"example","Example",[160,333,335],{"className":162,"code":334,"language":164,"meta":165,"style":165},"integrator.relief(fieldLayout, {channel: channel.luminance, cursor: force.cursorInView(fieldLayout, {perspK: 0.9}), stiffness: 18, maxSpeed: 4, minAlpha: 0.02, name: 'reliefUpdate'})\n",[8,336,337],{"__ignoreMap":165},[169,338,339,342,345,348,350,353,356,359,362,365,368,371,374,377,381],{"class":171,"line":172},[169,340,341],{"class":175},"integrator.",[169,343,344],{"class":179},"relief",[169,346,347],{"class":175},"(fieldLayout, {channel: channel.luminance, cursor: force.",[169,349,180],{"class":179},[169,351,352],{"class":175},"(fieldLayout, {perspK: ",[169,354,355],{"class":247},"0.9",[169,357,358],{"class":175},"}), stiffness: ",[169,360,361],{"class":247},"18",[169,363,364],{"class":175},", maxSpeed: ",[169,366,367],{"class":247},"4",[169,369,370],{"class":175},", minAlpha: ",[169,372,373],{"class":247},"0.02",[169,375,376],{"class":175},", name: ",[169,378,380],{"class":379},"sU2Wk","'reliefUpdate'",[169,382,383],{"class":175},"})\n",[273,385,387],{"id":386},"see-also","See also",[389,390,391,402],"ul",{},[392,393,394,401],"li",{},[395,396,398],"a",{"href":397},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator-relief",[8,399,400],{},"integrator.relief"," — Particles standing on the child's image, rising by a color channel, springing home.",[392,403,404,410,411,226,414,226,417,226,420,226,423,226,426,429,430,433],{},[395,405,407],{"href":406},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fchannel",[8,408,409],{},"channel"," — Which part of the child's color drives a particle: ",[8,412,413],{},"luminance",[8,415,416],{},"luminanceInverted",[8,418,419],{},"red",[8,421,422],{},"green",[8,424,425],{},"blue",[8,427,428],{},"saturation"," or ",[8,431,432],{},"alpha",", each a number in 0–1.",[435,436,437],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":186,"depth":186,"links":439},[440,441,442],{"id":275,"depth":186,"text":276},{"id":330,"depth":186,"text":331},{"id":386,"depth":186,"text":387},"sim.agentForces","sim-agentforces","Agent forces",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorinview",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentForces.ts#L1043","docs\u002Fprimitives\u002F41.sim-agentforces\u002F18.force-cursorinview","gyUBHn4TGNp2mRxwa6hWlsYzaPD3jzdAWL2vjAYcyVY"]