[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents":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":475,"categorySlug":476,"categoryTitle":477,"curated":478,"description":158,"editUrl":9,"extension":479,"group":480,"groupTitle":481,"kind":482,"meta":483,"navigation":484,"path":485,"seo":486,"sourceUrl":487,"stem":488,"wordCount":9,"__hash__":489},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F2.renderagents.md","renderAgents",{"type":149,"value":150,"toc":468},"minimark",[151,155,159,180,195,226,231,318,328,332,373,377,433,437,464],[152,153,147],"h1",{"id":154},"renderagents",[156,157,158],"p",{},"How the agents are drawn, as one declared part: a splat (each agent stamps its shape into a shared canvas) paired with the matching resolve (the canvas becomes the output picture).",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","renderAgents: { orientedWorld, pointWorld, volume, relief }\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV",": { orientedWorld, pointWorld, volume, relief }\n",[156,181,182,183,186,187,190,191,194],{},"Import ",[8,184,185],{},"sim"," from ",[8,188,189],{},"shaders\u002Fstd"," and use ",[8,192,193],{},"sim.agents.renderAgents",".",[156,196,197,198,201,202,205,206,209,210,213,214,217,218,221,222,225],{},"Four variants, one per kind of agent: ",[8,199,200],{},"orientedWorld"," for agents with a heading (arrows, streaks, comets) colored from rest to excited, ",[8,203,204],{},"pointWorld"," for round motes in one tint, ",[8,207,208],{},"volume"," for a 3D swarm seen in perspective, ",[8,211,212],{},"relief"," for particles that stand on an image. Put the returned ",[8,215,216],{},"splat"," and ",[8,219,220],{},"resolve"," into ",[8,223,224],{},"bake","'s pipelines and end the program with them.",[227,228,230],"h2",{"id":229},"example","Example",[160,232,234],{"className":162,"code":233,"language":164,"meta":165,"style":165},"const render = renderAgents.orientedWorld(simLayout, {shape: 'arrow', res: 1024, splatRCap: 16, heading: 'velocity', agitation: 'buffer', comet: true, ramp: {colorSpace: 2, trails: 'on'}, names: {splat: 'boidsSplat', resolve: 'boidsResolve'}})\n",[8,235,236],{"__ignoreMap":165},[169,237,238,242,246,249,252,254,257,261,264,267,270,273,276,279,282,285,288,291,294,297,300,303,306,309,312,315],{"class":171,"line":172},[169,239,241],{"class":240},"snl16","const",[169,243,245],{"class":244},"sDLfK"," render",[169,247,248],{"class":240}," =",[169,250,251],{"class":178}," renderAgents.",[169,253,200],{"class":175},[169,255,256],{"class":178},"(simLayout, {shape: ",[169,258,260],{"class":259},"sU2Wk","'arrow'",[169,262,263],{"class":178},", res: ",[169,265,266],{"class":244},"1024",[169,268,269],{"class":178},", splatRCap: ",[169,271,272],{"class":244},"16",[169,274,275],{"class":178},", heading: ",[169,277,278],{"class":259},"'velocity'",[169,280,281],{"class":178},", agitation: ",[169,283,284],{"class":259},"'buffer'",[169,286,287],{"class":178},", comet: ",[169,289,290],{"class":244},"true",[169,292,293],{"class":178},", ramp: {colorSpace: ",[169,295,296],{"class":244},"2",[169,298,299],{"class":178},", trails: ",[169,301,302],{"class":259},"'on'",[169,304,305],{"class":178},"}, names: {splat: ",[169,307,308],{"class":259},"'boidsSplat'",[169,310,311],{"class":178},", resolve: ",[169,313,314],{"class":259},"'boidsResolve'",[169,316,317],{"class":178},"}})\n",[319,320,321],"blockquote",{},[156,322,323,327],{},[324,325,326],"strong",{},"Tip."," The resolve also clears the canvas as it reads it, so no clear step is needed.",[227,329,331],{"id":330},"members","Members",[333,334,335,346,355,364],"ul",{},[336,337,338,345],"li",{},[339,340,342],"a",{"href":341},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-orientedworld",[8,343,344],{},"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.",[336,347,348,354],{},[339,349,351],{"href":350},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-pointworld",[8,352,353],{},"renderAgents.pointWorld"," — Round motes with no heading, drawn in one tint with a live softness.",[336,356,357,363],{},[339,358,360],{"href":359},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-volume",[8,361,362],{},"renderAgents.volume"," — A 3D swarm seen in perspective: nearer particles draw larger and brighter, and the color runs from rest to excited with speed.",[336,365,366,372],{},[339,367,369],{"href":368},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents-relief",[8,370,371],{},"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.",[227,374,376],{"id":375},"see-also","See also",[333,378,379,395,404,412],{},[336,380,381,387,388,390,391,394],{},[339,382,384],{"href":383},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Fagentsim",[8,385,386],{},"agentSim"," — A simulation of many agents, spread into a definition: ",[8,389,224],{}," assembles the steps from your declared parts, ",[8,392,393],{},"frame"," writes the per-frame values, and the fragment samples the picture.",[336,396,397,403],{},[339,398,400],{"href":399},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fop-splat",[8,401,402],{},"op.splat"," — A brush step: a soft round push into the grid at the pointer, scaled by how fast it moves.",[336,405,406,411],{},[339,407,409],{"href":408},"\u002Fdocs\u002Fprimitives\u002Fsim-agentrender\u002Fresolve",[8,410,220],{}," — The step that turns the shared canvas into the output picture and clears it for the next frame.",[336,413,414,420,421,424,425,428,429,432],{},[339,415,417],{"href":416},"\u002Fdocs\u002Fprimitives\u002Fsim-agentrender\u002Fpointslot",[8,418,419],{},"pointSlot"," — The three parts a round mote is drawn with: where it sits (",[8,422,423],{},"orbitalPlace","), how bright it is (",[8,426,427],{},"twinkleBrightness",") and how big it is (",[8,430,431],{},"presenceRadius",").",[227,434,436],{"id":435},"used-by","Used by",[156,438,439,443,444,443,448,443,452,443,456,443,460],{},[339,440,442],{"href":441},"\u002Fdocs\u002Fcomponents\u002Fboids","Boids",", ",[339,445,447],{"href":446},"\u002Fdocs\u002Fcomponents\u002Ffloatingparticles","FloatingParticles",[339,449,451],{"href":450},"\u002Fdocs\u002Fcomponents\u002Fmagneticfilings","MagneticFilings",[339,453,455],{"href":454},"\u002Fdocs\u002Fcomponents\u002Fparticlefield","ParticleField",[339,457,459],{"href":458},"\u002Fdocs\u002Fcomponents\u002Fparticleflow","ParticleFlow",[339,461,463],{"href":462},"\u002Fdocs\u002Fcomponents\u002Fparticles","Particles",[465,466,467],"style",{},"html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}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 .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}",{"title":165,"searchDepth":469,"depth":469,"links":470},2,[471,472,473,474],{"id":229,"depth":469,"text":230},{"id":330,"depth":469,"text":331},{"id":375,"depth":469,"text":376},{"id":435,"depth":469,"text":436},"sim.agents","sim-agents","Agents",false,"md","simulation","Simulation","object",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fagents.ts#L68","docs\u002Fprimitives\u002F40.sim-agents\u002F2.renderagents","DpmDU5PhKrQpMh8dPcG8mMRcsCMH8YX8nVFJKJl5dH0"]