[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce":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":497,"categorySlug":498,"categoryTitle":499,"curated":500,"description":157,"editUrl":9,"extension":501,"group":502,"groupTitle":503,"kind":504,"meta":505,"navigation":506,"path":507,"seo":508,"sourceUrl":509,"stem":510,"wordCount":9,"__hash__":511},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F8.force.md","force",{"type":149,"value":150,"toc":491},"minimark",[151,154,158,179,194,197,249,254,329,339,343,444,448,487],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"The pushes an agent can feel.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","force: { pressure, containment, cursorXY, gravity, turbulence, flocking, cursorSteer, wallTurn, cursorGust, cursorInView }\n","ts","",[8,166,167],{"__ignoreMap":164},[168,169,172,175],"span",{"class":170,"line":171},"line",1,[168,173,147],{"class":174},"svObZ",[168,176,178],{"class":177},"s95oV",": { pressure, containment, cursorXY, gravity, turbulence, flocking, cursorSteer, wallTurn, cursorGust, cursorInView }\n",[155,180,181,182,185,186,189,190,193],{},"Import ",[8,183,184],{},"sim"," from ",[8,187,188],{},"shaders\u002Fstd"," and use ",[8,191,192],{},"sim.agentForces.force",".",[155,195,196],{},"Each is built over your layout and returns a part the matching integrator folds in list order.",[155,198,199,200,203,204,207,208,211,212,215,216,215,219,222,223,203,226,215,229,215,232,235,236,203,239,242,243,203,246,193],{},"For a 3D swarm (",[8,201,202],{},"integrator.forces3d","): ",[8,205,206],{},"pressure"," (spread out evenly), ",[8,209,210],{},"containment"," (stay inside the shape), ",[8,213,214],{},"cursorXY",", ",[8,217,218],{},"gravity",[8,220,221],{},"turbulence",". For a flock (",[8,224,225],{},"integrator.steering2d",[8,227,228],{},"flocking",[8,230,231],{},"cursorSteer",[8,233,234],{},"wallTurn",". For drifting motes (",[8,237,238],{},"integrator.drift2d",[8,240,241],{},"cursorGust",". For an image relief (",[8,244,245],{},"integrator.relief",[8,247,248],{},"cursorInView",[250,251,253],"h2",{"id":252},"example","Example",[159,255,257],{"className":161,"code":256,"language":163,"meta":164,"style":164},"integrator.steering2d(simLayout, {forces: [force.flocking(simLayout, {maxAgents: 4096}), force.cursorSteer(simLayout), force.wallTurn(simLayout)], agitation: {rest: 1.5, gain: 0.45, cool: 1.3}, cruiseFloor: 0.35, wallRestitution: 0.6, name: 'boidsUpdate'})\n",[8,258,259],{"__ignoreMap":164},[168,260,261,264,267,270,272,275,279,282,284,287,289,292,295,298,301,304,307,310,313,316,319,322,326],{"class":170,"line":171},[168,262,263],{"class":177},"integrator.",[168,265,266],{"class":174},"steering2d",[168,268,269],{"class":177},"(simLayout, {forces: [force.",[168,271,228],{"class":174},[168,273,274],{"class":177},"(simLayout, {maxAgents: ",[168,276,278],{"class":277},"sDLfK","4096",[168,280,281],{"class":177},"}), force.",[168,283,231],{"class":174},[168,285,286],{"class":177},"(simLayout), force.",[168,288,234],{"class":174},[168,290,291],{"class":177},"(simLayout)], agitation: {rest: ",[168,293,294],{"class":277},"1.5",[168,296,297],{"class":177},", gain: ",[168,299,300],{"class":277},"0.45",[168,302,303],{"class":177},", cool: ",[168,305,306],{"class":277},"1.3",[168,308,309],{"class":177},"}, cruiseFloor: ",[168,311,312],{"class":277},"0.35",[168,314,315],{"class":177},", wallRestitution: ",[168,317,318],{"class":277},"0.6",[168,320,321],{"class":177},", name: ",[168,323,325],{"class":324},"sU2Wk","'boidsUpdate'",[168,327,328],{"class":177},"})\n",[330,331,332],"blockquote",{},[155,333,334,338],{},[335,336,337],"strong",{},"Tip."," Order matters only for readability. The forces are summed, so list them from the most important down.",[250,340,342],{"id":341},"members","Members",[344,345,346,357,366,375,387,399,408,417,426,435],"ul",{},[347,348,349,356],"li",{},[350,351,353],"a",{"href":352},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-pressure",[8,354,355],{},"force.pressure"," — Spread a 3D swarm evenly by pushing agents away from crowded cells of a density grid.",[347,358,359,365],{},[350,360,362],{"href":361},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-containment",[8,363,364],{},"force.containment"," — Keep a 3D swarm inside a shape: a spring at the surface, a pull back from far away, and a drag when the shape rotates.",[347,367,368,374],{},[350,369,371],{"href":370},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorxy",[8,372,373],{},"force.cursorXY"," — The cursor as a magnet on a 3D swarm, pushing away (or pulling in when the force is negative).",[347,376,377,383,384,193],{},[350,378,380],{"href":379},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-gravity",[8,381,382],{},"force.gravity"," — A constant pull on a 3D swarm in the direction of ",[8,385,386],{},"params.gravX, gravY",[347,388,389,395,396,193],{},[350,390,392],{"href":391},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-turbulence",[8,393,394],{},"force.turbulence"," — A per-agent jitter that keeps a 3D swarm alive, scaled by ",[8,397,398],{},"params.agitation",[347,400,401,407],{},[350,402,404],{"href":403},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-flocking",[8,405,406],{},"force.flocking"," — Separation, alignment and cohesion for a flock, with live weights and radii.",[347,409,410,416],{},[350,411,413],{"href":412},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorsteer",[8,414,415],{},"force.cursorSteer"," — The cursor on a flock: attract, scatter like a predator, or nothing.",[347,418,419,425],{},[350,420,422],{"href":421},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-wallturn",[8,423,424],{},"force.wallTurn"," — A soft turn back toward the canvas near an edge, so a flock arcs instead of bouncing.",[347,427,428,434],{},[350,429,431],{"href":430},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorgust",[8,432,433],{},"force.cursorGust"," — A puff from the cursor on drifting motes, zero while the force slider sits at 0.",[347,436,437,443],{},[350,438,440],{"href":439},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-cursorinview",[8,441,442],{},"force.cursorInView"," — The cursor on an image relief, applied where each particle appears on screen.",[250,445,447],{"id":446},"see-also","See also",[344,449,450,459,471,482],{},[347,451,452,458],{},[350,453,455],{"href":454},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fintegrator",[8,456,457],{},"integrator"," — The update step of an agent simulation: one per kind of agent.",[347,460,461,467,468,193],{},[350,462,464],{"href":463},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Ftorque",[8,465,466],{},"torque"," — The turns an agent that spins in place can feel, for ",[8,469,470],{},"integrator.orientation2d",[347,472,473,479,480,193],{},[350,474,476],{"href":475},"\u002Fdocs\u002Fprimitives\u002Fsim-shapefields\u002Fshapefield",[8,477,478],{},"shapeField"," — The signed-distance function of the shape a swarm lives in, for ",[8,481,364],{},[347,483,484],{},[8,485,486],{},"agentFrame",[488,489,490],"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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":164,"searchDepth":492,"depth":492,"links":493},2,[494,495,496],{"id":252,"depth":492,"text":253},{"id":341,"depth":492,"text":342},{"id":446,"depth":492,"text":447},"sim.agentForces","sim-agentforces","Agent forces",false,"md","simulation","Simulation","object",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentForces.ts#L1245","docs\u002Fprimitives\u002F41.sim-agentforces\u002F8.force","XF7ONmFRTp8EXr9evwQWHFy-QOOpkQ3Ai4VIPl7xZRI"]