[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fop-settle":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":415,"categorySlug":416,"categoryTitle":417,"curated":418,"description":419,"editUrl":9,"extension":420,"group":421,"groupTitle":422,"kind":423,"meta":424,"navigation":425,"path":426,"seo":427,"sourceUrl":428,"stem":429,"wordCount":9,"__hash__":430},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F11.op-settle.md","op.settle",{"type":149,"value":150,"toc":409},"minimark",[151,155,163,227,242,245,253,258,295,299,374,384,388,405],[152,153,147],"h1",{"id":154},"opsettle",[156,157,158,159,162],"p",{},"Sleep the simulation once nothing has driven it for ",[8,160,161],{},"settleMs"," of simulated time.",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-ts shiki shiki-themes github-dark","op.settle(opts: {activeWhen: (f: GridFrame) => boolean; settleMs: (f: GridFrame) => number}): GridStage\n","ts","",[8,171,172],{"__ignoreMap":169},[173,174,177,181,185,188,191,194,198,202,205,208,211,214,216,218,220,222,224],"span",{"class":175,"line":176},"line",1,[173,178,180],{"class":179},"s95oV","op.",[173,182,184],{"class":183},"svObZ","settle",[173,186,187],{"class":179},"(opts: {",[173,189,190],{"class":183},"activeWhen",[173,192,193],{"class":179},": (",[173,195,197],{"class":196},"s9osk","f",[173,199,201],{"class":200},"snl16",":",[173,203,204],{"class":183}," GridFrame",[173,206,207],{"class":179},") ",[173,209,210],{"class":200},"=>",[173,212,213],{"class":179}," boolean; settleMs: (",[173,215,197],{"class":196},[173,217,201],{"class":200},[173,219,204],{"class":183},[173,221,207],{"class":179},[173,223,210],{"class":200},[173,225,226],{"class":179}," number}): GridStage\n",[156,228,229,230,233,234,237,238,241],{},"Import ",[8,231,232],{},"sim"," from ",[8,235,236],{},"shaders\u002Fstd"," and use ",[8,239,240],{},"sim.grids.op.settle",".",[156,243,244],{},"Frames are skipped and the last published texture stays on screen, so a still field costs nothing.",[156,246,247,249,250,252],{},[8,248,190],{}," says whether something drove the field this frame. ",[8,251,161],{}," is how long the field takes to fade after the last activity, in milliseconds.",[254,255,257],"h2",{"id":256},"parameters","Parameters",[259,260,261,277],"table",{},[262,263,264],"thead",{},[265,266,267,271,274],"tr",{},[268,269,270],"th",{},"Name",[268,272,273],{},"Type",[268,275,276],{},"Notes",[278,279,280],"tbody",{},[265,281,282,288,293],{},[283,284,285],"td",{},[8,286,287],{},"opts",[283,289,290],{},[8,291,292],{},"{activeWhen: (f: GridFrame) => boolean; settleMs: (f: GridFrame) => number}",[283,294],{},[254,296,298],{"id":297},"example","Example",[164,300,302],{"className":166,"code":301,"language":168,"meta":169,"style":169},"op.settle({activeWhen: () => moving, settleMs: (f) => 4000 \u002F Math.max(f.num('decay', 1), 0.1)})\n",[8,303,304],{"__ignoreMap":169},[173,305,306,308,310,313,315,318,320,323,325,327,329,331,333,337,340,343,346,349,352,355,359,362,365,368,371],{"class":175,"line":176},[173,307,180],{"class":179},[173,309,184],{"class":183},[173,311,312],{"class":179},"({",[173,314,190],{"class":183},[173,316,317],{"class":179},": () ",[173,319,210],{"class":200},[173,321,322],{"class":179}," moving, ",[173,324,161],{"class":183},[173,326,193],{"class":179},[173,328,197],{"class":196},[173,330,207],{"class":179},[173,332,210],{"class":200},[173,334,336],{"class":335},"sDLfK"," 4000",[173,338,339],{"class":200}," \u002F",[173,341,342],{"class":179}," Math.",[173,344,345],{"class":183},"max",[173,347,348],{"class":179},"(f.",[173,350,351],{"class":183},"num",[173,353,354],{"class":179},"(",[173,356,358],{"class":357},"sU2Wk","'decay'",[173,360,361],{"class":179},", ",[173,363,364],{"class":335},"1",[173,366,367],{"class":179},"), ",[173,369,370],{"class":335},"0.1",[173,372,373],{"class":179},")})\n",[375,376,377],"blockquote",{},[156,378,379,383],{},[380,381,382],"strong",{},"Tip."," Simulated time, not wall-clock: a hidden tab does not count, so the field is still fading when the user comes back.",[254,385,387],{"id":386},"see-also","See also",[389,390,391],"ul",{},[392,393,394,401,402,404],"li",{},[395,396,398],"a",{"href":397},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fop-host",[8,399,400],{},"op.host"," — A named step that runs before any gate: pointer smoothing, activity flags, anything a later ",[8,403,184],{}," needs to know.",[406,407,408],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}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":169,"searchDepth":410,"depth":410,"links":411},2,[412,413,414],{"id":256,"depth":410,"text":257},{"id":297,"depth":410,"text":298},{"id":386,"depth":410,"text":387},"sim.grids","sim-grids","Grid programs",false,"Sleep the simulation once nothing has driven it for `settleMs` of simulated time.","md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fop-settle",{"title":147,"description":419},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L236","docs\u002Fprimitives\u002F37.sim-grids\u002F11.op-settle","ME-Ja2wlyBwz0YXnXJAQZh9YiZby7zy_LEKL8fe0g7o"]