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