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