[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostgridprogram":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":418,"categorySlug":419,"categoryTitle":420,"curated":421,"description":422,"editUrl":9,"extension":423,"group":424,"groupTitle":425,"kind":426,"meta":427,"navigation":428,"path":429,"seo":430,"sourceUrl":431,"stem":432,"wordCount":9,"__hash__":433},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F14.hostgridprogram.md","hostGridProgram",{"type":149,"value":150,"toc":411},"minimark",[151,155,163,210,224,230,237,242,279,283,358,362,392,396,407],[152,153,147],"h1",{"id":154},"hostgridprogram",[156,157,158,159,162],"p",{},"A frame program for a small grid stepped in plain JavaScript: the steps run in order every frame until one returns ",[8,160,161],{},"'skip'",".",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-ts shiki shiki-themes github-dark","hostGridProgram(opts: {clampDt: number; steps: HostStep[]}): (fp: unknown) => void\n","ts","",[8,171,172],{"__ignoreMap":169},[173,174,177,180,184,188,191,195,197,201,204,207],"span",{"class":175,"line":176},"line",1,[173,178,147],{"class":179},"svObZ",[173,181,183],{"class":182},"s95oV","(opts: {clampDt: number; steps: HostStep[]})",[173,185,187],{"class":186},"snl16",":",[173,189,190],{"class":182}," (",[173,192,194],{"class":193},"s9osk","fp",[173,196,187],{"class":186},[173,198,200],{"class":199},"sDLfK"," unknown",[173,202,203],{"class":182},") ",[173,205,206],{"class":186},"=>",[173,208,209],{"class":186}," void\n",[156,211,212,213,216,217,220,221,162],{},"Import ",[8,214,215],{},"sim"," from ",[8,218,219],{},"shaders\u002Fstd"," and use ",[8,222,223],{},"sim.grids.hostGridProgram",[156,225,226,227,162],{},"Hand the result to ",[8,228,229],{},"onBeforeRender",[156,231,232,233,236],{},"Use it when the field is small (a 32×32 flow grid) and the arithmetic reads better as loops. Publish the cells with ",[8,234,235],{},"hostFieldTexture"," in the last step.",[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",{},[8,270,271],{},"opts",[267,273,274],{},[8,275,276],{},"{clampDt: number; steps: HostStep[]}",[267,278],{},[238,280,282],{"id":281},"example","Example",[164,284,286],{"className":166,"code":285,"language":168,"meta":169,"style":169},"onBeforeRender(hostGridProgram({clampDt: 0.016, steps: [hostStep('advect', (f) => advect(f.dt)), hostStep('publish', () => { pack(field.texData); field.upload() })]}))\n",[8,287,288],{"__ignoreMap":169},[173,289,290,292,295,297,300,303,306,309,311,315,318,321,323,325,328,331,333,335,338,341,343,346,349,352,355],{"class":175,"line":176},[173,291,229],{"class":179},[173,293,294],{"class":182},"(",[173,296,147],{"class":179},[173,298,299],{"class":182},"({clampDt: ",[173,301,302],{"class":199},"0.016",[173,304,305],{"class":182},", steps: [",[173,307,308],{"class":179},"hostStep",[173,310,294],{"class":182},[173,312,314],{"class":313},"sU2Wk","'advect'",[173,316,317],{"class":182},", (",[173,319,320],{"class":193},"f",[173,322,203],{"class":182},[173,324,206],{"class":186},[173,326,327],{"class":179}," advect",[173,329,330],{"class":182},"(f.dt)), ",[173,332,308],{"class":179},[173,334,294],{"class":182},[173,336,337],{"class":313},"'publish'",[173,339,340],{"class":182},", () ",[173,342,206],{"class":186},[173,344,345],{"class":182}," { ",[173,347,348],{"class":179},"pack",[173,350,351],{"class":182},"(field.texData); field.",[173,353,354],{"class":179},"upload",[173,356,357],{"class":182},"() })]}))\n",[238,359,361],{"id":360},"see-also","See also",[363,364,365,375,383],"ul",{},[366,367,368,374],"li",{},[369,370,372],"a",{"href":371},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhoststep",[8,373,308],{}," — One named step of a JavaScript-stepped grid.",[366,376,377,382],{},[369,378,380],{"href":379},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostfieldtexture",[8,381,235],{}," — The texture a JavaScript-stepped grid is read through.",[366,384,385,391],{},[369,386,388],{"href":387},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fgridsim",[8,389,390],{},"gridSim"," — A field of cells advanced every frame by an ordered list of stages.",[238,393,395],{"id":394},"used-by","Used by",[156,397,398,402,403],{},[369,399,401],{"href":400},"\u002Fdocs\u002Fcomponents\u002Fchromaflow","ChromaFlow",", ",[369,404,406],{"href":405},"\u002Fdocs\u002Fcomponents\u002Fpixelthrow","PixelThrow",[408,409,410],"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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}html pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":169,"searchDepth":412,"depth":412,"links":413},2,[414,415,416,417],{"id":240,"depth":412,"text":241},{"id":281,"depth":412,"text":282},{"id":360,"depth":412,"text":361},{"id":394,"depth":412,"text":395},"sim.grids","sim-grids","Grid programs",false,"A frame program for a small grid stepped in plain JavaScript: the steps run in order every frame until one returns `'skip'`.","md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostgridprogram",{"title":147,"description":422},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L462","docs\u002Fprimitives\u002F37.sim-grids\u002F14.hostgridprogram","MDPycw5TvX9r8Y6R2AKsJGHRfdrW84pI7dsJXzL7yQI"]