[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-containment":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":501,"categorySlug":502,"categoryTitle":503,"curated":504,"description":158,"editUrl":9,"extension":505,"group":506,"groupTitle":507,"kind":508,"meta":509,"navigation":510,"path":511,"seo":512,"sourceUrl":513,"stem":514,"wordCount":9,"__hash__":515},"primitives\u002Fdocs\u002Fprimitives\u002F41.sim-agentforces\u002F13.force-containment.md","force.containment",{"type":149,"value":150,"toc":496},"minimark",[151,155,159,287,302,307,356,364,367,371,463,467,492],[152,153,147],"h1",{"id":154},"forcecontainment",[156,157,158],"p",{},"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.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","force.containment(layout: VolumeSwarmLayout, cfg: {\n    field: ShapeField3\n    \u002F** How far apart the two samples of the field's slope are taken. 0.02 is typical. *\u002F\n    \u002F\u002F Central-difference epsilon for the field gradient.\n    gradEps: number\n    \u002F** The spring at the surface: fades in from `featherFrom` to `featherTo` (signed distance), `base` push plus `springK` per unit outside. *\u002F\n    \u002F\u002F Strong outside, diffuse inside (a sharp feather packs a coherent shell).\n    wall: {featherFrom: number; featherTo: number; base: number; springK: number}\n    \u002F** The pull home once an agent is `from`..`to` from the origin, with strength `k`. *\u002F\n    \u002F\u002F A hard clamp piles strays into lines.\n    recall: {from: number; to: number; k: number}\n    \u002F** The pull toward the middle where the signed distance is `from`..`to`, with strength `k`. *\u002F\n    \u002F\u002F SDF-VALUE-driven pull toward the origin — direction-safe where the gradient degenerates.\n    homing: {from: number; to: number; k: number}\n    \u002F** How wide a band around the surface the rotation drag fades over. *\u002F\n    \u002F\u002F Drag toward the rotating container's feature velocity ω×r, feathered to inside.\n    entrainment: {featherHalf: number}\n}): AgentForce3\n","ts","",[8,167,168,184,190,197,203,209,215,221,227,233,239,245,251,257,263,269,275,281],{"__ignoreMap":165},[169,170,173,177,181],"span",{"class":171,"line":172},"line",1,[169,174,176],{"class":175},"s95oV","force.",[169,178,180],{"class":179},"svObZ","containment",[169,182,183],{"class":175},"(layout: VolumeSwarmLayout, cfg: {\n",[169,185,187],{"class":171,"line":186},2,[169,188,189],{"class":175},"    field: ShapeField3\n",[169,191,193],{"class":171,"line":192},3,[169,194,196],{"class":195},"sAwPA","    \u002F** How far apart the two samples of the field's slope are taken. 0.02 is typical. *\u002F\n",[169,198,200],{"class":171,"line":199},4,[169,201,202],{"class":195},"    \u002F\u002F Central-difference epsilon for the field gradient.\n",[169,204,206],{"class":171,"line":205},5,[169,207,208],{"class":175},"    gradEps: number\n",[169,210,212],{"class":171,"line":211},6,[169,213,214],{"class":195},"    \u002F** The spring at the surface: fades in from `featherFrom` to `featherTo` (signed distance), `base` push plus `springK` per unit outside. *\u002F\n",[169,216,218],{"class":171,"line":217},7,[169,219,220],{"class":195},"    \u002F\u002F Strong outside, diffuse inside (a sharp feather packs a coherent shell).\n",[169,222,224],{"class":171,"line":223},8,[169,225,226],{"class":175},"    wall: {featherFrom: number; featherTo: number; base: number; springK: number}\n",[169,228,230],{"class":171,"line":229},9,[169,231,232],{"class":195},"    \u002F** The pull home once an agent is `from`..`to` from the origin, with strength `k`. *\u002F\n",[169,234,236],{"class":171,"line":235},10,[169,237,238],{"class":195},"    \u002F\u002F A hard clamp piles strays into lines.\n",[169,240,242],{"class":171,"line":241},11,[169,243,244],{"class":175},"    recall: {from: number; to: number; k: number}\n",[169,246,248],{"class":171,"line":247},12,[169,249,250],{"class":195},"    \u002F** The pull toward the middle where the signed distance is `from`..`to`, with strength `k`. *\u002F\n",[169,252,254],{"class":171,"line":253},13,[169,255,256],{"class":195},"    \u002F\u002F SDF-VALUE-driven pull toward the origin — direction-safe where the gradient degenerates.\n",[169,258,260],{"class":171,"line":259},14,[169,261,262],{"class":175},"    homing: {from: number; to: number; k: number}\n",[169,264,266],{"class":171,"line":265},15,[169,267,268],{"class":195},"    \u002F** How wide a band around the surface the rotation drag fades over. *\u002F\n",[169,270,272],{"class":171,"line":271},16,[169,273,274],{"class":195},"    \u002F\u002F Drag toward the rotating container's feature velocity ω×r, feathered to inside.\n",[169,276,278],{"class":171,"line":277},17,[169,279,280],{"class":175},"    entrainment: {featherHalf: number}\n",[169,282,284],{"class":171,"line":283},18,[169,285,286],{"class":175},"}): AgentForce3\n",[156,288,289,290,293,294,297,298,301],{},"Import ",[8,291,292],{},"sim"," from ",[8,295,296],{},"shaders\u002Fstd"," and use ",[8,299,300],{},"sim.agentForces.force.containment",".",[303,304,306],"h2",{"id":305},"parameters","Parameters",[308,309,310,326],"table",{},[311,312,313],"thead",{},[314,315,316,320,323],"tr",{},[317,318,319],"th",{},"Name",[317,321,322],{},"Type",[317,324,325],{},"Notes",[327,328,329,344],"tbody",{},[314,330,331,337,342],{},[332,333,334],"td",{},[8,335,336],{},"layout",[332,338,339],{},[8,340,341],{},"VolumeSwarmLayout",[332,343],{},[314,345,346,351,354],{},[332,347,348],{},[8,349,350],{},"cfg",[332,352,353],{},"`{",[332,355],{},[160,357,362],{"className":358,"code":360,"language":361},[359],"language-text","field: ShapeField3\n\u002F** How far apart the two samples of the field's slope are taken. 0.02 is typical. *\u002F\n\u002F\u002F Central-difference epsilon for the field gradient.\ngradEps: number\n\u002F** The spring at the surface: fades in from `featherFrom` to `featherTo` (signed distance), `base` push plus `springK` per unit outside. *\u002F\n\u002F\u002F Strong outside, diffuse inside (a sharp feather packs a coherent shell).\nwall: {featherFrom: number; featherTo: number; base: number; springK: number}\n\u002F** The pull home once an agent is `from`..`to` from the origin, with strength `k`. *\u002F\n\u002F\u002F A hard clamp piles strays into lines.\nrecall: {from: number; to: number; k: number}\n\u002F** The pull toward the middle where the signed distance is `from`..`to`, with strength `k`. *\u002F\n\u002F\u002F SDF-VALUE-driven pull toward the origin — direction-safe where the gradient degenerates.\nhoming: {from: number; to: number; k: number}\n\u002F** How wide a band around the surface the rotation drag fades over. *\u002F\n\u002F\u002F Drag toward the rotating container's feature velocity ω×r, feathered to inside.\nentrainment: {featherHalf: number}\n","text",[8,363,360],{"__ignoreMap":165},[156,365,366],{},"}` |  |",[303,368,370],{"id":369},"example","Example",[160,372,374],{"className":162,"code":373,"language":164,"meta":165,"style":165},"forces: [pressure.force, force.containment(simLayout, {field: hexField, gradEps: 0.02, wall: {featherFrom: -0.1, featherTo: 0.01, base: 1.1, springK: 22}, recall: {from: 0.85, to: 1.1, k: 9}, homing: {from: 0.12, to: 0.45, k: 5}, entrainment: {featherHalf: 0.05}})]\n",[8,375,376],{"__ignoreMap":165},[169,377,378,381,384,386,389,393,396,400,403,406,409,412,415,418,421,424,427,430,432,435,438,441,444,446,449,451,454,457,460],{"class":171,"line":172},[169,379,380],{"class":179},"forces",[169,382,383],{"class":175},": [pressure.force, force.",[169,385,180],{"class":179},[169,387,388],{"class":175},"(simLayout, {field: hexField, gradEps: ",[169,390,392],{"class":391},"sDLfK","0.02",[169,394,395],{"class":175},", wall: {featherFrom: ",[169,397,399],{"class":398},"snl16","-",[169,401,402],{"class":391},"0.1",[169,404,405],{"class":175},", featherTo: ",[169,407,408],{"class":391},"0.01",[169,410,411],{"class":175},", base: ",[169,413,414],{"class":391},"1.1",[169,416,417],{"class":175},", springK: ",[169,419,420],{"class":391},"22",[169,422,423],{"class":175},"}, recall: {from: ",[169,425,426],{"class":391},"0.85",[169,428,429],{"class":175},", to: ",[169,431,414],{"class":391},[169,433,434],{"class":175},", k: ",[169,436,437],{"class":391},"9",[169,439,440],{"class":175},"}, homing: {from: ",[169,442,443],{"class":391},"0.12",[169,445,429],{"class":175},[169,447,448],{"class":391},"0.45",[169,450,434],{"class":175},[169,452,453],{"class":391},"5",[169,455,456],{"class":175},"}, entrainment: {featherHalf: ",[169,458,459],{"class":391},"0.05",[169,461,462],{"class":175},"}})]\n",[303,464,466],{"id":465},"see-also","See also",[468,469,470,483],"ul",{},[471,472,473,480,481,301],"li",{},[474,475,477],"a",{"href":476},"\u002Fdocs\u002Fprimitives\u002Fsim-shapefields\u002Fshapefield",[8,478,479],{},"shapeField"," — The signed-distance function of the shape a swarm lives in, for ",[8,482,147],{},[471,484,485,491],{},[474,486,488],{"href":487},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-pressure",[8,489,490],{},"force.pressure"," — Spread a 3D swarm evenly by pushing agents away from crowded cells of a density grid.",[493,494,495],"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 .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}",{"title":165,"searchDepth":186,"depth":186,"links":497},[498,499,500],{"id":305,"depth":186,"text":306},{"id":369,"depth":186,"text":370},{"id":465,"depth":186,"text":466},"sim.agentForces","sim-agentforces","Agent forces",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce-containment",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentForces.ts#L239","docs\u002Fprimitives\u002F41.sim-agentforces\u002F13.force-containment","6Zsnx5ML5Q59KPdBNuQYRCEUWQKT8cFEqllJvoi_ams"]