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