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