[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Fagentsim":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":683,"categorySlug":684,"categoryTitle":685,"curated":686,"description":687,"editUrl":9,"extension":688,"group":689,"groupTitle":690,"kind":691,"meta":692,"navigation":693,"path":694,"seo":695,"sourceUrl":696,"stem":697,"wordCount":9,"__hash__":698},"primitives\u002Fdocs\u002Fprimitives\u002F40.sim-agents\u002F1.agentsim.md","agentSim",{"type":149,"value":150,"toc":676},"minimark",[151,155,167,222,237,257,262,298,302,578,592,596,642,646,672],[152,153,147],"h1",{"id":154},"agentsim",[156,157,158,159,162,163,166],"p",{},"A simulation of many agents, spread into a definition: ",[8,160,161],{},"bake"," assembles the steps from your declared parts, ",[8,164,165],{},"frame"," writes the per-frame values, and the fragment samples the picture.",[168,169,174],"pre",{"className":170,"code":171,"language":172,"meta":173,"style":173},"language-ts shiki shiki-themes github-dark","agentSim\u003CTParams extends AnyWgslStruct>(cfg: AgentSimConfig\u003CTParams>): AgentSimSpread\n","ts","",[8,175,176],{"__ignoreMap":173},[177,178,181,185,189,193,196,199,203,206,209,212,214,217,219],"span",{"class":179,"line":180},"line",1,[177,182,184],{"class":183},"s95oV","agentSim\u003C",[177,186,188],{"class":187},"svObZ","TParams",[177,190,192],{"class":191},"snl16"," extends",[177,194,195],{"class":187}," AnyWgslStruct",[177,197,198],{"class":183},">(",[177,200,202],{"class":201},"s9osk","cfg",[177,204,205],{"class":191},":",[177,207,208],{"class":187}," AgentSimConfig",[177,210,211],{"class":183},"\u003C",[177,213,188],{"class":187},[177,215,216],{"class":183},">)",[177,218,205],{"class":191},[177,220,221],{"class":187}," AgentSimSpread\n",[156,223,224,225,228,229,232,233,236],{},"Import ",[8,226,227],{},"sim"," from ",[8,230,231],{},"shaders\u002Fstd"," and use ",[8,234,235],{},"sim.agents.agentSim",".",[156,238,239,241,242,244,245,248,249,252,253,256],{},[8,240,161],{}," runs once per composition with the compile-time props (shape, color space) and returns the pipelines and their order. ",[8,243,165],{}," runs once per frame: read props, write ",[8,246,247],{},"sys.writeParams(...)",", return ",[8,250,251],{},"sys.frame({count})",". The spawn step runs before the first frame and again whenever ",[8,254,255],{},"reseed"," changes. Without a GPU the fragment shows the fallback.",[258,259,261],"h2",{"id":260},"parameters","Parameters",[263,264,265,281],"table",{},[266,267,268],"thead",{},[269,270,271,275,278],"tr",{},[272,273,274],"th",{},"Name",[272,276,277],{},"Type",[272,279,280],{},"Notes",[282,283,284],"tbody",{},[269,285,286,291,296],{},[287,288,289],"td",{},[8,290,202],{},[287,292,293],{},[8,294,295],{},"AgentSimConfig\u003CTParams>",[287,297],{},[258,299,301],{"id":300},"example","Example",[168,303,305],{"className":170,"code":304,"language":172,"meta":173,"style":173},"...agentSim\u003Ctypeof SimParams>({layout: simLayout, params: SimParams, maxAgents: 4096, countCap: {desktop: 4096, mobile: 1200}, output: {key: 'outTex', name: 'boidsTexture', size: [1024, 1024], format: 'rgba16float'}, bake: ({getCpuValue}) => { const render = boidsRender(getCpuValue('agentShape') as string); return {pipelines: {init: {kernel: boidsInitKernel, threads: 'max'}, update: {kernel: boidsUpdateKernel, threads: 'agents'}, splat: render.splat, resolve: render.resolve}, initStep: 'init', program: ['update', 'splat', 'resolve']} }, frame: (sys, {getCpuValue}) => (frameParams) => { const {dt, aspect} = readAgentFrame(frameParams); const count = sys.resolveCount(getCpuValue('count') as number); sys.writeParams({...}); return sys.frame({count}) }, fragment: {output: 'boidsTexture', fallback: 'transparent'}})\n",[8,306,307],{"__ignoreMap":173},[177,308,309,312,314,316,319,322,326,329,331,334,337,340,344,347,350,353,356,359,361,364,367,370,372,375,378,381,384,387,390,393,396,399,402,404,406,409,412,415,418,421,424,427,430,433,436,439,442,445,448,450,453,455,458,461,463,466,469,472,474,476,478,481,484,486,488,490,492,495,498,500,503,506,509,512,515,517,520,522,525,528,530,532,534,537,539,541,544,547,550,553,555,558,560,562,564,567,569,572,575],{"class":179,"line":180},[177,310,311],{"class":191},"...",[177,313,147],{"class":187},[177,315,211],{"class":183},[177,317,318],{"class":191},"typeof",[177,320,321],{"class":183}," SimParams>({layout: simLayout, params: SimParams, maxAgents: ",[177,323,325],{"class":324},"sDLfK","4096",[177,327,328],{"class":183},", countCap: {desktop: ",[177,330,325],{"class":324},[177,332,333],{"class":183},", mobile: ",[177,335,336],{"class":324},"1200",[177,338,339],{"class":183},"}, output: {key: ",[177,341,343],{"class":342},"sU2Wk","'outTex'",[177,345,346],{"class":183},", name: ",[177,348,349],{"class":342},"'boidsTexture'",[177,351,352],{"class":183},", size: [",[177,354,355],{"class":324},"1024",[177,357,358],{"class":183},", ",[177,360,355],{"class":324},[177,362,363],{"class":183},"], format: ",[177,365,366],{"class":342},"'rgba16float'",[177,368,369],{"class":183},"}, ",[177,371,161],{"class":187},[177,373,374],{"class":183},": ({",[177,376,377],{"class":201},"getCpuValue",[177,379,380],{"class":183},"}) ",[177,382,383],{"class":191},"=>",[177,385,386],{"class":183}," { ",[177,388,389],{"class":191},"const",[177,391,392],{"class":324}," render",[177,394,395],{"class":191}," =",[177,397,398],{"class":187}," boidsRender",[177,400,401],{"class":183},"(",[177,403,377],{"class":187},[177,405,401],{"class":183},[177,407,408],{"class":342},"'agentShape'",[177,410,411],{"class":183},") ",[177,413,414],{"class":191},"as",[177,416,417],{"class":324}," string",[177,419,420],{"class":183},"); ",[177,422,423],{"class":191},"return",[177,425,426],{"class":183}," {pipelines: {init: {kernel: boidsInitKernel, threads: ",[177,428,429],{"class":342},"'max'",[177,431,432],{"class":183},"}, update: {kernel: boidsUpdateKernel, threads: ",[177,434,435],{"class":342},"'agents'",[177,437,438],{"class":183},"}, splat: render.splat, resolve: render.resolve}, initStep: ",[177,440,441],{"class":342},"'init'",[177,443,444],{"class":183},", program: [",[177,446,447],{"class":342},"'update'",[177,449,358],{"class":183},[177,451,452],{"class":342},"'splat'",[177,454,358],{"class":183},[177,456,457],{"class":342},"'resolve'",[177,459,460],{"class":183},"]} }, ",[177,462,165],{"class":187},[177,464,465],{"class":183},": (",[177,467,468],{"class":201},"sys",[177,470,471],{"class":183},", {",[177,473,377],{"class":201},[177,475,380],{"class":183},[177,477,383],{"class":191},[177,479,480],{"class":183}," (",[177,482,483],{"class":201},"frameParams",[177,485,411],{"class":183},[177,487,383],{"class":191},[177,489,386],{"class":183},[177,491,389],{"class":191},[177,493,494],{"class":183}," {",[177,496,497],{"class":324},"dt",[177,499,358],{"class":183},[177,501,502],{"class":324},"aspect",[177,504,505],{"class":183},"} ",[177,507,508],{"class":191},"=",[177,510,511],{"class":187}," readAgentFrame",[177,513,514],{"class":183},"(frameParams); ",[177,516,389],{"class":191},[177,518,519],{"class":324}," count",[177,521,395],{"class":191},[177,523,524],{"class":183}," sys.",[177,526,527],{"class":187},"resolveCount",[177,529,401],{"class":183},[177,531,377],{"class":187},[177,533,401],{"class":183},[177,535,536],{"class":342},"'count'",[177,538,411],{"class":183},[177,540,414],{"class":191},[177,542,543],{"class":324}," number",[177,545,546],{"class":183},"); sys.",[177,548,549],{"class":187},"writeParams",[177,551,552],{"class":183},"({",[177,554,311],{"class":191},[177,556,557],{"class":183},"}); ",[177,559,423],{"class":191},[177,561,524],{"class":183},[177,563,165],{"class":187},[177,565,566],{"class":183},"({count}) }, fragment: {output: ",[177,568,349],{"class":342},[177,570,571],{"class":183},", fallback: ",[177,573,574],{"class":342},"'transparent'",[177,576,577],{"class":183},"}})\n",[579,580,581],"blockquote",{},[156,582,583,587,588,591],{},[584,585,586],"strong",{},"Tip."," Clamp the count prop with ",[8,589,590],{},"sys.resolveCount"," rather than reading it raw, so a desktop preset still loads on a phone.",[258,593,595],{"id":594},"see-also","See also",[597,598,599,610,619,628,633],"ul",{},[600,601,602,609],"li",{},[603,604,606],"a",{"href":605},"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Frenderagents",[8,607,608],{},"renderAgents"," — 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).",[600,611,612,618],{},[603,613,615],{"href":614},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator",[8,616,617],{},"integrator"," — The update step of an agent simulation: one per kind of agent.",[600,620,621,627],{},[603,622,624],{"href":623},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce",[8,625,626],{},"force"," — The pushes an agent can feel.",[600,629,630],{},[8,631,632],{},"agentFrame",[600,634,635,641],{},[603,636,638],{"href":637},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fsimulate",[8,639,640],{},"simulate"," — Declare a simulation the engine runs for you.",[258,643,645],{"id":644},"used-by","Used by",[156,647,648,358,652,358,656,358,660,358,664,358,668],{},[603,649,651],{"href":650},"\u002Fdocs\u002Fcomponents\u002Fboids","Boids",[603,653,655],{"href":654},"\u002Fdocs\u002Fcomponents\u002Ffloatingparticles","FloatingParticles",[603,657,659],{"href":658},"\u002Fdocs\u002Fcomponents\u002Fmagneticfilings","MagneticFilings",[603,661,663],{"href":662},"\u002Fdocs\u002Fcomponents\u002Fparticlefield","ParticleField",[603,665,667],{"href":666},"\u002Fdocs\u002Fcomponents\u002Fparticleflow","ParticleFlow",[603,669,671],{"href":670},"\u002Fdocs\u002Fcomponents\u002Fparticles","Particles",[673,674,675],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":173,"searchDepth":677,"depth":677,"links":678},2,[679,680,681,682],{"id":260,"depth":677,"text":261},{"id":300,"depth":677,"text":301},{"id":594,"depth":677,"text":595},{"id":644,"depth":677,"text":645},"sim.agents","sim-agents","Agents",false,"A simulation of many agents, spread into a definition: `bake` assembles the steps from your declared parts, `frame` writes the per-frame values, and the fragment samples the picture.","md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agents\u002Fagentsim",{"title":147,"description":687},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fagents.ts#L289","docs\u002Fprimitives\u002F40.sim-agents\u002F1.agentsim","UavDP6YpdDPMuW05WllsKLsbVV1hf5oTC8CPhqNP--A"]