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