[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator-relief":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":511,"categorySlug":512,"categoryTitle":513,"curated":514,"description":158,"editUrl":9,"extension":515,"group":516,"groupTitle":517,"kind":518,"meta":519,"navigation":520,"path":521,"seo":522,"sourceUrl":523,"stem":524,"wordCount":9,"__hash__":525},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F6.integrator-relief.md","integrator.relief",{"type":149,"value":150,"toc":506},"minimark",[151,155,159,318,332,337,386,394,397,401,452,456,502],[152,153,147],"h1",{"id":154},"integratorrelief",[156,157,158],"p",{},"Particles standing on the child's image, rising by a color channel, springing home.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","integrator.relief(layout: ReliefLayout, cfg: {\n    channel: AgentChannel\n    cursor: (homeW: d.v2f, off: d.v2f, z: number) => d.v3f\n    stiffness: number\n    maxSpeed: number\n    \u002F** Child alpha below which a particle is never latched. Match the render's `minAlpha`. *\u002F\n    \u002F\u002F Matches the splat's early-out.\n    minAlpha: number\n    name: string\n}): (x: number, y: number) => void\n","ts","",[8,167,168,184,190,247,253,259,266,272,278,284],{"__ignoreMap":165},[169,170,173,177,181],"span",{"class":171,"line":172},"line",1,[169,174,176],{"class":175},"s95oV","integrator.",[169,178,180],{"class":179},"svObZ","relief",[169,182,183],{"class":175},"(layout: ReliefLayout, cfg: {\n",[169,185,187],{"class":171,"line":186},2,[169,188,189],{"class":175},"    channel: AgentChannel\n",[169,191,193,196,200,204,207,210,213,216,219,221,223,225,227,229,232,234,238,241,244],{"class":171,"line":192},3,[169,194,195],{"class":175},"    cursor: (",[169,197,199],{"class":198},"s9osk","homeW",[169,201,203],{"class":202},"snl16",":",[169,205,206],{"class":179}," d",[169,208,209],{"class":175},".",[169,211,212],{"class":179},"v2f",[169,214,215],{"class":175},", ",[169,217,218],{"class":198},"off",[169,220,203],{"class":202},[169,222,206],{"class":179},[169,224,209],{"class":175},[169,226,212],{"class":179},[169,228,215],{"class":175},[169,230,231],{"class":198},"z",[169,233,203],{"class":202},[169,235,237],{"class":236},"sDLfK"," number",[169,239,240],{"class":175},") ",[169,242,243],{"class":202},"=>",[169,245,246],{"class":175}," d.v3f\n",[169,248,250],{"class":171,"line":249},4,[169,251,252],{"class":175},"    stiffness: number\n",[169,254,256],{"class":171,"line":255},5,[169,257,258],{"class":175},"    maxSpeed: number\n",[169,260,262],{"class":171,"line":261},6,[169,263,265],{"class":264},"sAwPA","    \u002F** Child alpha below which a particle is never latched. Match the render's `minAlpha`. *\u002F\n",[169,267,269],{"class":171,"line":268},7,[169,270,271],{"class":264},"    \u002F\u002F Matches the splat's early-out.\n",[169,273,275],{"class":171,"line":274},8,[169,276,277],{"class":175},"    minAlpha: number\n",[169,279,281],{"class":171,"line":280},9,[169,282,283],{"class":175},"    name: string\n",[169,285,287,290,292,295,298,300,302,304,307,309,311,313,315],{"class":171,"line":286},10,[169,288,289],{"class":175},"})",[169,291,203],{"class":202},[169,293,294],{"class":175}," (",[169,296,297],{"class":198},"x",[169,299,203],{"class":202},[169,301,237],{"class":236},[169,303,215],{"class":175},[169,305,306],{"class":198},"y",[169,308,203],{"class":202},[169,310,237],{"class":236},[169,312,240],{"class":175},[169,314,243],{"class":202},[169,316,317],{"class":202}," void\n",[156,319,320,321,324,325,328,329,209],{},"Import ",[8,322,323],{},"sim"," from ",[8,326,327],{},"shaders\u002Fstd"," and use ",[8,330,331],{},"sim.agentForces.integrator.relief",[333,334,336],"h2",{"id":335},"parameters","Parameters",[338,339,340,356],"table",{},[341,342,343],"thead",{},[344,345,346,350,353],"tr",{},[347,348,349],"th",{},"Name",[347,351,352],{},"Type",[347,354,355],{},"Notes",[357,358,359,374],"tbody",{},[344,360,361,367,372],{},[362,363,364],"td",{},[8,365,366],{},"layout",[362,368,369],{},[8,370,371],{},"ReliefLayout",[362,373],{},[344,375,376,381,384],{},[362,377,378],{},[8,379,380],{},"cfg",[362,382,383],{},"`{",[362,385],{},[160,387,392],{"className":388,"code":390,"language":391},[389],"language-text","channel: AgentChannel\ncursor: (homeW: d.v2f, off: d.v2f, z: number) => d.v3f\nstiffness: number\nmaxSpeed: number\n\u002F** Child alpha below which a particle is never latched. Match the render's `minAlpha`. *\u002F\n\u002F\u002F Matches the splat's early-out.\nminAlpha: number\nname: string\n","text",[8,393,390],{"__ignoreMap":165},[156,395,396],{},"}` |  |",[333,398,400],{"id":399},"example","Example",[160,402,404],{"className":162,"code":403,"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,405,406],{"__ignoreMap":165},[169,407,408,410,412,415,418,421,424,427,430,433,436,439,442,445,449],{"class":171,"line":172},[169,409,176],{"class":175},[169,411,180],{"class":179},[169,413,414],{"class":175},"(fieldLayout, {channel: channel.luminance, cursor: force.",[169,416,417],{"class":179},"cursorInView",[169,419,420],{"class":175},"(fieldLayout, {perspK: ",[169,422,423],{"class":236},"0.9",[169,425,426],{"class":175},"}), stiffness: ",[169,428,429],{"class":236},"18",[169,431,432],{"class":175},", maxSpeed: ",[169,434,435],{"class":236},"4",[169,437,438],{"class":175},", minAlpha: ",[169,440,441],{"class":236},"0.02",[169,443,444],{"class":175},", name: ",[169,446,448],{"class":447},"sU2Wk","'reliefUpdate'",[169,450,451],{"class":175},"})\n",[333,453,455],{"id":454},"see-also","See also",[457,458,459,493],"ul",{},[460,461,462,469,470,215,473,215,476,215,479,215,482,215,485,488,489,492],"li",{},[463,464,466],"a",{"href":465},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fchannel",[8,467,468],{},"channel"," — Which part of the child's color drives a particle: ",[8,471,472],{},"luminance",[8,474,475],{},"luminanceInverted",[8,477,478],{},"red",[8,480,481],{},"green",[8,483,484],{},"blue",[8,486,487],{},"saturation"," or ",[8,490,491],{},"alpha",", each a number in 0–1.",[460,494,495,501],{},[463,496,498],{"href":497},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorinview",[8,499,500],{},"force.cursorInView"," — The cursor on an image relief, applied where each particle appears on screen.",[503,504,505],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}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":507},[508,509,510],{"id":335,"depth":186,"text":336},{"id":399,"depth":186,"text":400},{"id":454,"depth":186,"text":455},"sim.agentForces","sim-agentforces","Agent forces",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator-relief",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentForces.ts#L1074","docs\u002Fprimitives\u002F41.sim-agentforces\u002F6.integrator-relief","zWLNTyUqSpvNrQ5uvVSWqWAZw9aavaWSqDKt6EmKRkE"]