[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-relief":129},{"stars":4},5505,[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":423,"categorySlug":424,"categoryTitle":425,"curated":426,"description":142,"editUrl":427,"extension":428,"group":429,"groupTitle":430,"kind":431,"meta":432,"navigation":433,"path":434,"seo":435,"sourceUrl":436,"stem":437,"wordCount":427,"__hash__":438},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F6.renderagents-relief.md","renderAgents.relief",{"type":133,"value":134,"toc":417},"minimark",[135,139,143,230,245,251,256,305,313,317,385,389,403,407,413],[136,137,131],"h1",{"id":138},"renderagentsrelief",[140,141,142],"p",{},"Particles standing on an image, seen through a camera: each carries the child's color at its home, and nearer particles win the color where they overlap.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"language-ts shiki shiki-themes github-dark","renderAgents.relief(layout: Parameters\u003Ctypeof splat.relief>[0], cfg: Omit\u003CReliefSplatConfig, 'name'> & {\n            out: [number, number]\n            weightedColor: {alphaK: number}\n            names: {splat: string; resolve: string}\n        }): RenderAgentsPipelines\n","ts","",[10,151,152,206,212,218,224],{"__ignoreMap":149},[153,154,157,161,165,168,172,175,178,181,185,188,191,194,198,200,203],"span",{"class":155,"line":156},"line",1,[153,158,160],{"class":159},"s95oV","renderAgents.",[153,162,164],{"class":163},"svObZ","relief",[153,166,167],{"class":159},"(layout: Parameters",[153,169,171],{"class":170},"snl16","\u003Ctypeof",[153,173,174],{"class":159}," splat.relief",[153,176,177],{"class":170},">",[153,179,180],{"class":159},"[",[153,182,184],{"class":183},"sDLfK","0",[153,186,187],{"class":159},"], cfg: Omit",[153,189,190],{"class":170},"\u003C",[153,192,193],{"class":159},"ReliefSplatConfig, ",[153,195,197],{"class":196},"sU2Wk","'name'",[153,199,177],{"class":170},[153,201,202],{"class":170}," &",[153,204,205],{"class":159}," {\n",[153,207,209],{"class":155,"line":208},2,[153,210,211],{"class":159},"            out: [number, number]\n",[153,213,215],{"class":155,"line":214},3,[153,216,217],{"class":159},"            weightedColor: {alphaK: number}\n",[153,219,221],{"class":155,"line":220},4,[153,222,223],{"class":159},"            names: {splat: string; resolve: string}\n",[153,225,227],{"class":155,"line":226},5,[153,228,229],{"class":159},"        }): RenderAgentsPipelines\n",[140,231,232,233,236,237,240,241,244],{},"Import ",[10,234,235],{},"sim"," from ",[10,238,239],{},"shaders\u002Fstd"," and use ",[10,242,243],{},"sim.agents.renderAgents.relief",".",[140,246,247,250],{},[10,248,249],{},"out"," is the output size in texels.",[252,253,255],"h2",{"id":254},"parameters","Parameters",[257,258,259,275],"table",{},[260,261,262],"thead",{},[263,264,265,269,272],"tr",{},[266,267,268],"th",{},"Name",[266,270,271],{},"Type",[266,273,274],{},"Notes",[276,277,278,293],"tbody",{},[263,279,280,286,291],{},[281,282,283],"td",{},[10,284,285],{},"layout",[281,287,288],{},[10,289,290],{},"Parameters\u003Ctypeof splat.relief>[0]",[281,292],{},[263,294,295,300,303],{},[281,296,297],{},[10,298,299],{},"cfg",[281,301,302],{},"`Omit\u003CReliefSplatConfig, 'name'> & {",[281,304],{},[144,306,311],{"className":307,"code":309,"language":310},[308],"language-text","        out: [number, number]\n        weightedColor: {alphaK: number}\n        names: {splat: string; resolve: string}\n    }` |  |\n","text",[10,312,309],{"__ignoreMap":149},[252,314,316],{"id":315},"example","Example",[144,318,320],{"className":146,"code":319,"language":148,"meta":149,"style":149},"renderAgents.relief(fieldLayout, {shape, splatRCap: 24, aaW: 0.75, minAlpha: 0.02, fp: 1024, wobbleFreq: 1.3, perspK: 0.9, out: [outW, outH], weightedColor: {alphaK: 1.6}, names: {splat: 'reliefSplat', resolve: 'reliefResolve'}})\n",[10,321,322],{"__ignoreMap":149},[153,323,324,326,328,331,334,337,340,343,346,349,352,355,358,361,364,367,370,373,376,379,382],{"class":155,"line":156},[153,325,160],{"class":159},[153,327,164],{"class":163},[153,329,330],{"class":159},"(fieldLayout, {shape, splatRCap: ",[153,332,333],{"class":183},"24",[153,335,336],{"class":159},", aaW: ",[153,338,339],{"class":183},"0.75",[153,341,342],{"class":159},", minAlpha: ",[153,344,345],{"class":183},"0.02",[153,347,348],{"class":159},", fp: ",[153,350,351],{"class":183},"1024",[153,353,354],{"class":159},", wobbleFreq: ",[153,356,357],{"class":183},"1.3",[153,359,360],{"class":159},", perspK: ",[153,362,363],{"class":183},"0.9",[153,365,366],{"class":159},", out: [outW, outH], weightedColor: {alphaK: ",[153,368,369],{"class":183},"1.6",[153,371,372],{"class":159},"}, names: {splat: ",[153,374,375],{"class":196},"'reliefSplat'",[153,377,378],{"class":159},", resolve: ",[153,380,381],{"class":196},"'reliefResolve'",[153,383,384],{"class":159},"}})\n",[252,386,388],{"id":387},"see-also","See also",[390,391,392],"ul",{},[393,394,395,402],"li",{},[396,397,399],"a",{"href":398},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume",[10,400,401],{},"renderAgents.volume"," — A 3D swarm seen in perspective: nearer particles draw larger and brighter, and the color runs from rest to excited with speed.",[252,404,406],{"id":405},"used-by","Used by",[140,408,409],{},[396,410,412],{"href":411},"\u002Fdocs\u002Fcomponents\u002Fparticlefield","ParticleField",[414,415,416],"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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}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);}",{"title":149,"searchDepth":208,"depth":208,"links":418},[419,420,421,422],{"id":254,"depth":208,"text":255},{"id":315,"depth":208,"text":316},{"id":387,"depth":208,"text":388},{"id":405,"depth":208,"text":406},"sim.agents","sim-agents","Agents",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-relief",{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fagents.ts#L186","docs\u002Fprimitives\u002F40.sim-agents\u002F6.renderagents-relief","UxguCOdEG0Oy0PR9FVREhE_U_ZtLjpBvf3BfUXuuKco"]