[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume":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":495,"categorySlug":496,"categoryTitle":497,"curated":498,"description":158,"editUrl":9,"extension":499,"group":500,"groupTitle":501,"kind":502,"meta":503,"navigation":504,"path":505,"seo":506,"sourceUrl":507,"stem":508,"wordCount":9,"__hash__":509},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F5.renderagents-volume.md","renderAgents.volume",{"type":149,"value":150,"toc":489},"minimark",[151,155,159,289,304,309,358,366,370,448,452,475,479,485],[152,153,147],"h1",{"id":154},"renderagentsvolume",[156,157,158],"p",{},"A 3D swarm seen in perspective: nearer particles draw larger and brighter, and the color runs from rest to excited with speed.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","renderAgents.volume(layout: Parameters\u003Ctypeof splat.volume>[0] & RampResolveLayout, cfg: Omit\u003CVolumeSplatConfig, 'names'> & {\n            ramp: Omit\u003CRampResolveConfig, 'name' | 'res' | 'invGain'>\n            names: VolumeSplatConfig['names'] & {resolve: string}\n            extraOnSplat?: boolean\n        }): RenderAgentsPipelines\n","ts","",[8,167,168,228,256,271,283],{"__ignoreMap":165},[169,170,173,177,181,184,188,191,194,197,201,204,207,210,213,216,220,222,225],"span",{"class":171,"line":172},"line",1,[169,174,176],{"class":175},"s95oV","renderAgents.",[169,178,180],{"class":179},"svObZ","volume",[169,182,183],{"class":175},"(layout: Parameters",[169,185,187],{"class":186},"snl16","\u003Ctypeof",[169,189,190],{"class":175}," splat.volume",[169,192,193],{"class":186},">",[169,195,196],{"class":175},"[",[169,198,200],{"class":199},"sDLfK","0",[169,202,203],{"class":175},"] ",[169,205,206],{"class":186},"&",[169,208,209],{"class":175}," RampResolveLayout, cfg: Omit",[169,211,212],{"class":186},"\u003C",[169,214,215],{"class":175},"VolumeSplatConfig, ",[169,217,219],{"class":218},"sU2Wk","'names'",[169,221,193],{"class":186},[169,223,224],{"class":186}," &",[169,226,227],{"class":175}," {\n",[169,229,231,234,236,239,242,245,248,250,253],{"class":171,"line":230},2,[169,232,233],{"class":175},"            ramp: Omit",[169,235,212],{"class":186},[169,237,238],{"class":175},"RampResolveConfig, ",[169,240,241],{"class":218},"'name'",[169,243,244],{"class":175}," | ",[169,246,247],{"class":218},"'res'",[169,249,244],{"class":175},[169,251,252],{"class":218},"'invGain'",[169,254,255],{"class":175},">\n",[169,257,259,262,264,266,268],{"class":171,"line":258},3,[169,260,261],{"class":175},"            names: VolumeSplatConfig[",[169,263,219],{"class":218},[169,265,203],{"class":175},[169,267,206],{"class":186},[169,269,270],{"class":175}," {resolve: string}\n",[169,272,274,277,280],{"class":171,"line":273},4,[169,275,276],{"class":175},"            extraOnSplat",[169,278,279],{"class":186},"?:",[169,281,282],{"class":175}," boolean\n",[169,284,286],{"class":171,"line":285},5,[169,287,288],{"class":175},"        }): RenderAgentsPipelines\n",[156,290,291,292,295,296,299,300,303],{},"Import ",[8,293,294],{},"sim"," from ",[8,297,298],{},"shaders\u002Fstd"," and use ",[8,301,302],{},"sim.agents.renderAgents.volume",".",[305,306,308],"h2",{"id":307},"parameters","Parameters",[310,311,312,328],"table",{},[313,314,315],"thead",{},[316,317,318,322,325],"tr",{},[319,320,321],"th",{},"Name",[319,323,324],{},"Type",[319,326,327],{},"Notes",[329,330,331,346],"tbody",{},[316,332,333,339,344],{},[334,335,336],"td",{},[8,337,338],{},"layout",[334,340,341],{},[8,342,343],{},"Parameters\u003Ctypeof splat.volume>[0] & RampResolveLayout",[334,345],{},[316,347,348,353,356],{},[334,349,350],{},[8,351,352],{},"cfg",[334,354,355],{},"`Omit\u003CVolumeSplatConfig, 'names'> & {",[334,357],{},[160,359,364],{"className":360,"code":362,"language":363},[361],"language-text","        ramp: Omit\u003CRampResolveConfig, 'name' \\| 'res' \\| 'invGain'>\n        names: VolumeSplatConfig['names'] & {resolve: string}\n        extraOnSplat?: boolean\n    }` |  |\n","text",[8,365,362],{"__ignoreMap":165},[305,367,369],{"id":368},"example","Example",[160,371,373],{"className":162,"code":372,"language":164,"meta":165,"style":165},"renderAgents.volume(simLayout, {shape, outRes: 1024, maxSplatSize: 12, extQ: 6, ramp: {colorSpace: 0, exposure: true, trails: 'none'}, names: {splat: 'swarmSplat', glow: 'swarmGlow', profile: 'swarmProfile', resolve: 'swarmResolve'}, extraOnSplat: true})\n",[8,374,375],{"__ignoreMap":165},[169,376,377,379,381,384,387,390,393,396,399,402,404,407,410,413,416,419,422,425,428,431,434,437,440,443,445],{"class":171,"line":172},[169,378,176],{"class":175},[169,380,180],{"class":179},[169,382,383],{"class":175},"(simLayout, {shape, outRes: ",[169,385,386],{"class":199},"1024",[169,388,389],{"class":175},", maxSplatSize: ",[169,391,392],{"class":199},"12",[169,394,395],{"class":175},", extQ: ",[169,397,398],{"class":199},"6",[169,400,401],{"class":175},", ramp: {colorSpace: ",[169,403,200],{"class":199},[169,405,406],{"class":175},", exposure: ",[169,408,409],{"class":199},"true",[169,411,412],{"class":175},", trails: ",[169,414,415],{"class":218},"'none'",[169,417,418],{"class":175},"}, names: {splat: ",[169,420,421],{"class":218},"'swarmSplat'",[169,423,424],{"class":175},", glow: ",[169,426,427],{"class":218},"'swarmGlow'",[169,429,430],{"class":175},", profile: ",[169,432,433],{"class":218},"'swarmProfile'",[169,435,436],{"class":175},", resolve: ",[169,438,439],{"class":218},"'swarmResolve'",[169,441,442],{"class":175},"}, extraOnSplat: ",[169,444,409],{"class":199},[169,446,447],{"class":175},"})\n",[305,449,451],{"id":450},"see-also","See also",[453,454,455,466],"ul",{},[456,457,458,465],"li",{},[459,460,462],"a",{"href":461},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld",[8,463,464],{},"renderAgents.orientedWorld"," — Agents with a heading, drawn as a shape pointing the way they move (or the way they are turned), colored from a rest color to an excited color.",[456,467,468,474],{},[459,469,471],{"href":470},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-relief",[8,472,473],{},"renderAgents.relief"," — 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.",[305,476,478],{"id":477},"used-by","Used by",[156,480,481],{},[459,482,484],{"href":483},"\u002Fdocs\u002Fcomponents\u002Fparticles","Particles",[486,487,488],"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":230,"depth":230,"links":490},[491,492,493,494],{"id":307,"depth":230,"text":308},{"id":368,"depth":230,"text":369},{"id":450,"depth":230,"text":451},{"id":477,"depth":230,"text":478},"sim.agents","sim-agents","Agents",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fagents.ts#L151","docs\u002Fprimitives\u002F40.sim-agents\u002F5.renderagents-volume","g9VI7q5YRcw1P7PYdlueb9F47_yBoi0p6TSCPx6IPV8"]