[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator-relief":129},{"stars":4},5507,[6,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,72,76,80,84,88,93,97,101,105,109,113,117,121,125],{"path":7,"title":8,"description":9,"category":10},"\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",{"path":12,"title":13,"description":14,"category":10},"\u002Fdocs\u002Fguide\u002Fquickstart","Quickstart","Install Shaders, render your first effect, and drive a prop from state.",{"path":16,"title":17,"description":18,"category":10},"\u002Fdocs\u002Fguide\u002Fcomposing-effects","Composing effects","Stack components as layers and nest them to control which layers an effect touches.",{"path":20,"title":21,"description":22,"category":10},"\u002Fdocs\u002Fguide\u002Fblending-masking","Blending and masking","Control how a layer mixes with the layers below it, and reveal one layer through another.",{"path":24,"title":25,"description":26,"category":10},"\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":28,"title":29,"description":30,"category":10},"\u002Fdocs\u002Fguide\u002Fdynamic-props","Dynamic props","Drive any numeric or position prop from time, the cursor, or another layer, without writing animation code.",{"path":32,"title":33,"description":34,"category":10},"\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":36,"title":37,"description":38,"category":10},"\u002Fdocs\u002Fguide\u002Fsizing-and-units","Sizing and units","Size and place layers in CSS units (px, %, vw, rem, and canvas units) that stay correct as the canvas and window resize.",{"path":40,"title":41,"description":42,"category":10},"\u002Fdocs\u002Fguide\u002Ftransforms","Transforms","Position, size, and rotate any layer inside the canvas with a bounding box, in any CSS unit.",{"path":44,"title":45,"description":46,"category":10},"\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":48,"title":49,"description":50,"category":10},"\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":52,"title":53,"description":54,"category":10},"\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":56,"title":57,"description":58,"category":10},"\u002Fdocs\u002Fguide\u002Fperformance","Performance","Learn what makes an effect expensive on the GPU and how to keep it inside the frame budget.",{"path":60,"title":61,"description":62,"category":10},"\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":64,"title":65,"description":66,"category":10},"\u002Fdocs\u002Fguide\u002Ftelemetry","Telemetry","The `\u003CShader>` component occasionally sends an anonymous performance report to help us improve the engine over time.",{"path":68,"title":69,"description":70,"category":71},"\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":73,"title":74,"description":75,"category":71},"\u002Fdocs\u002Fguide\u002Fcli","Shaders CLI","Install your own shaders and Pro shaders into your codebase as component files, and keep them in sync with the design editor.",{"path":77,"title":78,"description":79,"category":71},"\u002Fdocs\u002Fguide\u002Fagent-skill","Agent skill","Give your coding agent a skill that teaches it to build with Shaders components, the CLI and Pro shaders.",{"path":81,"title":82,"description":83,"category":10},"\u002Fdocs\u002Fguide\u002Fvideo-rendering","Rendering to video","Turn a shader effect into a video file, from the design editor or from a frame-by-frame pipeline such as Remotion, Hyperframes or Puppeteer.",{"path":85,"title":86,"description":87,"category":10},"\u002Fdocs\u002Fguide\u002Fssr","Server rendering","Render Shaders in Next.js, Nuxt, SvelteKit, SolidStart and other SSR apps by keeping each shader on the client.",{"path":89,"title":90,"description":91,"category":92},"\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":94,"title":95,"description":96,"category":92},"\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":98,"title":99,"description":100,"category":92},"\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":102,"title":103,"description":104,"category":92},"\u002Fdocs\u002Fguide\u002Fmasking-and-blending","Masking and blending","How blend modes and masks combine components in the design editor.",{"path":106,"title":107,"description":108,"category":92},"\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":110,"title":111,"description":112,"category":92},"\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":114,"title":115,"description":116,"category":92},"\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":118,"title":119,"description":120,"category":92},"\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":122,"title":123,"description":124,"category":92},"\u002Fdocs\u002Fguide\u002Fglass-component-spotlight","Component spotlight: Glass","A short look at the Glass component and the liquid-glass look it creates.",{"path":126,"title":127,"description":128,"category":92},"\u002Fdocs\u002Fguide\u002Fdigital-looks-component-spotlight","Component spotlight: Digital looks","A look at the digital stylization components for glitchy, futuristic, or technical effects.",{"id":130,"title":131,"body":132,"categoryId":495,"categorySlug":496,"categoryTitle":497,"curated":498,"description":142,"editUrl":499,"extension":500,"group":501,"groupTitle":502,"kind":503,"meta":504,"navigation":505,"path":506,"seo":507,"sourceUrl":508,"stem":509,"wordCount":499,"__hash__":510},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F6.integrator-relief.md","integrator.relief",{"type":133,"value":134,"toc":490},"minimark",[135,139,143,302,316,321,370,378,381,385,436,440,486],[136,137,131],"h1",{"id":138},"integratorrelief",[140,141,142],"p",{},"Particles standing on the child's image, rising by a color channel, springing home.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"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","",[10,151,152,168,174,231,237,243,250,256,262,268],{"__ignoreMap":149},[153,154,157,161,165],"span",{"class":155,"line":156},"line",1,[153,158,160],{"class":159},"s95oV","integrator.",[153,162,164],{"class":163},"svObZ","relief",[153,166,167],{"class":159},"(layout: ReliefLayout, cfg: {\n",[153,169,171],{"class":155,"line":170},2,[153,172,173],{"class":159},"    channel: AgentChannel\n",[153,175,177,180,184,188,191,194,197,200,203,205,207,209,211,213,216,218,222,225,228],{"class":155,"line":176},3,[153,178,179],{"class":159},"    cursor: (",[153,181,183],{"class":182},"s9osk","homeW",[153,185,187],{"class":186},"snl16",":",[153,189,190],{"class":163}," d",[153,192,193],{"class":159},".",[153,195,196],{"class":163},"v2f",[153,198,199],{"class":159},", ",[153,201,202],{"class":182},"off",[153,204,187],{"class":186},[153,206,190],{"class":163},[153,208,193],{"class":159},[153,210,196],{"class":163},[153,212,199],{"class":159},[153,214,215],{"class":182},"z",[153,217,187],{"class":186},[153,219,221],{"class":220},"sDLfK"," number",[153,223,224],{"class":159},") ",[153,226,227],{"class":186},"=>",[153,229,230],{"class":159}," d.v3f\n",[153,232,234],{"class":155,"line":233},4,[153,235,236],{"class":159},"    stiffness: number\n",[153,238,240],{"class":155,"line":239},5,[153,241,242],{"class":159},"    maxSpeed: number\n",[153,244,246],{"class":155,"line":245},6,[153,247,249],{"class":248},"sAwPA","    \u002F** Child alpha below which a particle is never latched. Match the render's `minAlpha`. *\u002F\n",[153,251,253],{"class":155,"line":252},7,[153,254,255],{"class":248},"    \u002F\u002F Matches the splat's early-out.\n",[153,257,259],{"class":155,"line":258},8,[153,260,261],{"class":159},"    minAlpha: number\n",[153,263,265],{"class":155,"line":264},9,[153,266,267],{"class":159},"    name: string\n",[153,269,271,274,276,279,282,284,286,288,291,293,295,297,299],{"class":155,"line":270},10,[153,272,273],{"class":159},"})",[153,275,187],{"class":186},[153,277,278],{"class":159}," (",[153,280,281],{"class":182},"x",[153,283,187],{"class":186},[153,285,221],{"class":220},[153,287,199],{"class":159},[153,289,290],{"class":182},"y",[153,292,187],{"class":186},[153,294,221],{"class":220},[153,296,224],{"class":159},[153,298,227],{"class":186},[153,300,301],{"class":186}," void\n",[140,303,304,305,308,309,312,313,193],{},"Import ",[10,306,307],{},"sim"," from ",[10,310,311],{},"shaders\u002Fstd"," and use ",[10,314,315],{},"sim.agentForces.integrator.relief",[317,318,320],"h2",{"id":319},"parameters","Parameters",[322,323,324,340],"table",{},[325,326,327],"thead",{},[328,329,330,334,337],"tr",{},[331,332,333],"th",{},"Name",[331,335,336],{},"Type",[331,338,339],{},"Notes",[341,342,343,358],"tbody",{},[328,344,345,351,356],{},[346,347,348],"td",{},[10,349,350],{},"layout",[346,352,353],{},[10,354,355],{},"ReliefLayout",[346,357],{},[328,359,360,365,368],{},[346,361,362],{},[10,363,364],{},"cfg",[346,366,367],{},"`{",[346,369],{},[144,371,376],{"className":372,"code":374,"language":375},[373],"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",[10,377,374],{"__ignoreMap":149},[140,379,380],{},"}` |  |",[317,382,384],{"id":383},"example","Example",[144,386,388],{"className":146,"code":387,"language":148,"meta":149,"style":149},"integrator.relief(fieldLayout, {channel: channel.luminance, cursor: force.cursorInView(fieldLayout, {perspK: 0.9}), stiffness: 18, maxSpeed: 4, minAlpha: 0.02, name: 'reliefUpdate'})\n",[10,389,390],{"__ignoreMap":149},[153,391,392,394,396,399,402,405,408,411,414,417,420,423,426,429,433],{"class":155,"line":156},[153,393,160],{"class":159},[153,395,164],{"class":163},[153,397,398],{"class":159},"(fieldLayout, {channel: channel.luminance, cursor: force.",[153,400,401],{"class":163},"cursorInView",[153,403,404],{"class":159},"(fieldLayout, {perspK: ",[153,406,407],{"class":220},"0.9",[153,409,410],{"class":159},"}), stiffness: ",[153,412,413],{"class":220},"18",[153,415,416],{"class":159},", maxSpeed: ",[153,418,419],{"class":220},"4",[153,421,422],{"class":159},", minAlpha: ",[153,424,425],{"class":220},"0.02",[153,427,428],{"class":159},", name: ",[153,430,432],{"class":431},"sU2Wk","'reliefUpdate'",[153,434,435],{"class":159},"})\n",[317,437,439],{"id":438},"see-also","See also",[441,442,443,477],"ul",{},[444,445,446,453,454,199,457,199,460,199,463,199,466,199,469,472,473,476],"li",{},[447,448,450],"a",{"href":449},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fchannel",[10,451,452],{},"channel"," — Which part of the child's color drives a particle: ",[10,455,456],{},"luminance",[10,458,459],{},"luminanceInverted",[10,461,462],{},"red",[10,464,465],{},"green",[10,467,468],{},"blue",[10,470,471],{},"saturation"," or ",[10,474,475],{},"alpha",", each a number in 0–1.",[444,478,479,485],{},[447,480,482],{"href":481},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorinview",[10,483,484],{},"force.cursorInView"," — The cursor on an image relief, applied where each particle appears on screen.",[487,488,489],"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":149,"searchDepth":170,"depth":170,"links":491},[492,493,494],{"id":319,"depth":170,"text":320},{"id":383,"depth":170,"text":384},{"id":438,"depth":170,"text":439},"sim.agentForces","sim-agentforces","Agent forces",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator-relief",{"title":131,"description":142},"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"]