[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Fentrainmentfromomega":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":399,"categorySlug":400,"categoryTitle":401,"curated":402,"description":403,"editUrl":9,"extension":404,"group":405,"groupTitle":406,"kind":407,"meta":408,"navigation":409,"path":410,"seo":411,"sourceUrl":412,"stem":413,"wordCount":9,"__hash__":414},"primitives\u002Fdocs\u002Fprimitives\u002F42.sim-agentframe\u002F8.entrainmentfromomega.md","entrainmentFromOmega",{"type":149,"value":150,"toc":394},"minimark",[151,155,175,214,228,233,284,288,353,363,367,390],[152,153,147],"h1",{"id":154},"entrainmentfromomega",[156,157,158,159,162,163,166,167,170,171,174],"p",{},"The values ",[8,160,161],{},"force.containment"," reads for a rotating shape: the rotation rate capped at ",[8,164,165],{},"cap",", and an ",[8,168,169],{},"entrain"," gain that grows with the rate up to ",[8,172,173],{},"gainMax",".",[176,177,182],"pre",{"className":178,"code":179,"language":180,"meta":181,"style":181},"language-ts shiki shiki-themes github-dark","entrainmentFromOmega(\n  om: {x: number; y: number; z: number},\n  opts: {cap: number; gainRate: number; gainMax: number},\n): { omegaX: number; omegaY: number; omegaZ: number; entrain: number; }\n","ts","",[8,183,184,196,202,208],{"__ignoreMap":181},[185,186,189,192],"span",{"class":187,"line":188},"line",1,[185,190,147],{"class":191},"svObZ",[185,193,195],{"class":194},"s95oV","(\n",[185,197,199],{"class":187,"line":198},2,[185,200,201],{"class":194},"  om: {x: number; y: number; z: number},\n",[185,203,205],{"class":187,"line":204},3,[185,206,207],{"class":194},"  opts: {cap: number; gainRate: number; gainMax: number},\n",[185,209,211],{"class":187,"line":210},4,[185,212,213],{"class":194},"): { omegaX: number; omegaY: number; omegaZ: number; entrain: number; }\n",[156,215,216,217,220,221,224,225,174],{},"Import ",[8,218,219],{},"sim"," from ",[8,222,223],{},"shaders\u002Fstd"," and use ",[8,226,227],{},"sim.agentFrame.entrainmentFromOmega",[229,230,232],"h2",{"id":231},"parameters","Parameters",[234,235,236,252],"table",{},[237,238,239],"thead",{},[240,241,242,246,249],"tr",{},[243,244,245],"th",{},"Name",[243,247,248],{},"Type",[243,250,251],{},"Notes",[253,254,255,270],"tbody",{},[240,256,257,263,268],{},[258,259,260],"td",{},[8,261,262],{},"om",[258,264,265],{},[8,266,267],{},"{x: number; y: number; z: number}",[258,269],{},[240,271,272,277,282],{},[258,273,274],{},[8,275,276],{},"opts",[258,278,279],{},[8,280,281],{},"{cap: number; gainRate: number; gainMax: number}",[258,283],{},[229,285,287],{"id":286},"example","Example",[176,289,291],{"className":178,"code":290,"language":180,"meta":181,"style":181},"const {omegaX, omegaY, omegaZ, entrain} = agentFrame.entrainmentFromOmega(om, {cap: 10, gainRate: 2.5, gainMax: 5})\n",[8,292,293],{"__ignoreMap":181},[185,294,295,299,302,306,309,312,314,317,319,321,324,327,330,332,335,338,341,344,347,350],{"class":187,"line":188},[185,296,298],{"class":297},"snl16","const",[185,300,301],{"class":194}," {",[185,303,305],{"class":304},"sDLfK","omegaX",[185,307,308],{"class":194},", ",[185,310,311],{"class":304},"omegaY",[185,313,308],{"class":194},[185,315,316],{"class":304},"omegaZ",[185,318,308],{"class":194},[185,320,169],{"class":304},[185,322,323],{"class":194},"} ",[185,325,326],{"class":297},"=",[185,328,329],{"class":194}," agentFrame.",[185,331,147],{"class":191},[185,333,334],{"class":194},"(om, {cap: ",[185,336,337],{"class":304},"10",[185,339,340],{"class":194},", gainRate: ",[185,342,343],{"class":304},"2.5",[185,345,346],{"class":194},", gainMax: ",[185,348,349],{"class":304},"5",[185,351,352],{"class":194},"})\n",[354,355,356],"blockquote",{},[156,357,358,362],{},[359,360,361],"strong",{},"Tip."," With a still shape the gain is exactly 0, so the entrainment force costs nothing to leave declared.",[229,364,366],{"id":365},"see-also","See also",[368,369,370,381],"ul",{},[371,372,373,380],"li",{},[374,375,377],"a",{"href":376},"\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Fomegafromrotationdeltas",[8,378,379],{},"omegaFromRotationDeltas"," — How fast a rotating shape's surface moves, from its rotation this frame and last frame, so a swarm inside it can be dragged along.",[371,382,383,389],{},[374,384,386],{"href":385},"\u002Fdocs\u002Fprimitives\u002Fsim-agentforces\u002Fforce",[8,387,388],{},"force"," — The pushes an agent can feel.",[391,392,393],"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}",{"title":181,"searchDepth":198,"depth":198,"links":395},[396,397,398],{"id":231,"depth":198,"text":232},{"id":286,"depth":198,"text":287},{"id":365,"depth":198,"text":366},"sim.agentFrame","sim-agentframe","Agent frame",false,"The values `force.containment` reads for a rotating shape: the rotation rate capped at `cap`, and an `entrain` gain that grows with the rate up to `gainMax`.","md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-agentframe\u002Fentrainmentfromomega",{"title":147,"description":403},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002FagentFrame.ts#L119","docs\u002Fprimitives\u002F42.sim-agentframe\u002F8.entrainmentfromomega","kIQmdfn5axRPwJcGXZ-VczN7gjmyPQ00cjeTBShTnLg"]