[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhoststep":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":370,"categorySlug":371,"categoryTitle":372,"curated":373,"description":142,"editUrl":374,"extension":375,"group":376,"groupTitle":377,"kind":378,"meta":379,"navigation":380,"path":381,"seo":382,"sourceUrl":383,"stem":384,"wordCount":374,"__hash__":385},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F15.hoststep.md","hostStep",{"type":133,"value":134,"toc":363},"minimark",[135,139,143,194,209,216,221,272,276,324,328,344,348,359],[136,137,131],"h1",{"id":138},"hoststep",[140,141,142],"p",{},"One named step of a JavaScript-stepped grid.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"language-ts shiki shiki-themes github-dark","hostStep(name: string, run: (f: HostFrame) => void | 'skip'): HostStep\n","ts","",[10,151,152],{"__ignoreMap":149},[153,154,157,160,164,168,172,175,178,181,184,187,191],"span",{"class":155,"line":156},"line",1,[153,158,131],{"class":159},"svObZ",[153,161,163],{"class":162},"s95oV","(name: string, run: (",[153,165,167],{"class":166},"s9osk","f",[153,169,171],{"class":170},"snl16",":",[153,173,174],{"class":159}," HostFrame",[153,176,177],{"class":162},") ",[153,179,180],{"class":170},"=>",[153,182,183],{"class":170}," void",[153,185,186],{"class":170}," |",[153,188,190],{"class":189},"sU2Wk"," 'skip'",[153,192,193],{"class":162},"): HostStep\n",[140,195,196,197,200,201,204,205,208],{},"Import ",[10,198,199],{},"sim"," from ",[10,202,203],{},"shaders\u002Fstd"," and use ",[10,206,207],{},"sim.grids.hostStep",".",[140,210,211,212,215],{},"Return ",[10,213,214],{},"'skip'"," to end the frame here, which is how an idle gate is written.",[217,218,220],"h2",{"id":219},"parameters","Parameters",[222,223,224,240],"table",{},[225,226,227],"thead",{},[228,229,230,234,237],"tr",{},[231,232,233],"th",{},"Name",[231,235,236],{},"Type",[231,238,239],{},"Notes",[241,242,243,258],"tbody",{},[228,244,245,251,256],{},[246,247,248],"td",{},[10,249,250],{},"name",[246,252,253],{},[10,254,255],{},"string",[246,257],{},[228,259,260,265,270],{},[246,261,262],{},[10,263,264],{},"run",[246,266,267],{},[10,268,269],{},"(f: HostFrame) => void | 'skip'",[246,271],{},[217,273,275],{"id":274},"example","Example",[144,277,279],{"className":146,"code":278,"language":148,"meta":149,"style":149},"hostStep('dtGuard', (f) => (f.dt \u003C= 0 ? 'skip' : undefined))\n",[10,280,281],{"__ignoreMap":149},[153,282,283,285,288,291,294,296,298,300,303,306,310,313,315,318,321],{"class":155,"line":156},[153,284,131],{"class":159},[153,286,287],{"class":162},"(",[153,289,290],{"class":189},"'dtGuard'",[153,292,293],{"class":162},", (",[153,295,167],{"class":166},[153,297,177],{"class":162},[153,299,180],{"class":170},[153,301,302],{"class":162}," (f.dt ",[153,304,305],{"class":170},"\u003C=",[153,307,309],{"class":308},"sDLfK"," 0",[153,311,312],{"class":170}," ?",[153,314,190],{"class":189},[153,316,317],{"class":170}," :",[153,319,320],{"class":308}," undefined",[153,322,323],{"class":162},"))\n",[217,325,327],{"id":326},"see-also","See also",[329,330,331],"ul",{},[332,333,334,341,342,208],"li",{},[335,336,338],"a",{"href":337},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostgridprogram",[10,339,340],{},"hostGridProgram"," — A frame program for a small grid stepped in plain JavaScript: the steps run in order every frame until one returns ",[10,343,214],{},[217,345,347],{"id":346},"used-by","Used by",[140,349,350,354,355],{},[335,351,353],{"href":352},"\u002Fdocs\u002Fcomponents\u002Fchromaflow","ChromaFlow",", ",[335,356,358],{"href":357},"\u002Fdocs\u002Fcomponents\u002Fpixelthrow","PixelThrow",[360,361,362],"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 pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}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}",{"title":149,"searchDepth":364,"depth":364,"links":365},2,[366,367,368,369],{"id":219,"depth":364,"text":220},{"id":274,"depth":364,"text":275},{"id":326,"depth":364,"text":327},{"id":346,"depth":364,"text":347},"sim.grids","sim-grids","Grid programs",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhoststep",{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L446","docs\u002Fprimitives\u002F37.sim-grids\u002F15.hoststep","XgpnHrufi2K1TFkaWx9p_94aY_fHZ8iVm_KDyru2ua4"]