[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fgridsim":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":488,"categorySlug":489,"categoryTitle":490,"curated":491,"description":158,"editUrl":9,"extension":492,"group":493,"groupTitle":494,"kind":495,"meta":496,"navigation":497,"path":498,"seo":499,"sourceUrl":500,"stem":501,"wordCount":9,"__hash__":502},"primitives\u002Fdocs\u002Fprimitives\u002F37.sim-grids\u002F1.gridsim.md","gridSim",{"type":149,"value":150,"toc":481},"minimark",[151,155,159,221,236,243,246,251,288,292,388,398,402,455,459,477],[152,153,147],"h1",{"id":154},"gridsim",[156,157,158],"p",{},"A field of cells advanced every frame by an ordered list of stages.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","gridSim(build: (params: GpuFragmentParams, root: GridRoot) => GridSimConfig | null): {compute: GpuComputeNode}\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184,188,191,194,197,199,202,205,208,211,214,218],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(build: (",[169,181,183],{"class":182},"s9osk","params",[169,185,187],{"class":186},"snl16",":",[169,189,190],{"class":175}," GpuFragmentParams",[169,192,193],{"class":178},", ",[169,195,196],{"class":182},"root",[169,198,187],{"class":186},[169,200,201],{"class":175}," GridRoot",[169,203,204],{"class":178},") ",[169,206,207],{"class":186},"=>",[169,209,210],{"class":178}," GridSimConfig ",[169,212,213],{"class":186},"|",[169,215,217],{"class":216},"sDLfK"," null",[169,219,220],{"class":178},"): {compute: GpuComputeNode}\n",[156,222,223,224,227,228,231,232,235],{},"Import ",[8,225,226],{},"sim"," from ",[8,229,230],{},"shaders\u002Fstd"," and use ",[8,233,234],{},"sim.grids.gridSim",".",[156,237,238,239,242],{},"Spread it into a definition next to a ",[8,240,241],{},"gpu.fragment"," that samples one of its outputs.",[156,244,245],{},"The build callback runs once per instance of the layer, with the GPU device, and returns the outputs, the frame-delta clamp and the stages. Return null to run nothing (a required child is missing). Without a GPU the fragment should fall back to the child or to transparent.",[247,248,250],"h2",{"id":249},"parameters","Parameters",[252,253,254,270],"table",{},[255,256,257],"thead",{},[258,259,260,264,267],"tr",{},[261,262,263],"th",{},"Name",[261,265,266],{},"Type",[261,268,269],{},"Notes",[271,272,273],"tbody",{},[258,274,275,281,286],{},[276,277,278],"td",{},[8,279,280],{},"build",[276,282,283],{},[8,284,285],{},"(params: GpuFragmentParams, root: GridRoot) => GridSimConfig | null",[276,287],{},[247,289,291],{"id":290},"example","Example",[160,293,295],{"className":162,"code":294,"language":164,"meta":165,"style":165},"...gridSim((params, root) => ({outputs: {state}, clampDt: 0.05, stages: [op.values('write', (f) => paramsU.write({dt: f.dt, radius: f.num('radius', 0.4)})), op.pass(update), op.publish(() => output)]}))\n",[8,296,297],{"__ignoreMap":165},[169,298,299,302,304,307,309,311,313,315,317,320,323,326,329,332,336,339,342,344,346,349,352,355,358,360,363,365,368,371,374,377,380,383,385],{"class":171,"line":172},[169,300,301],{"class":186},"...",[169,303,147],{"class":175},[169,305,306],{"class":178},"((",[169,308,183],{"class":182},[169,310,193],{"class":178},[169,312,196],{"class":182},[169,314,204],{"class":178},[169,316,207],{"class":186},[169,318,319],{"class":178}," ({outputs: {state}, clampDt: ",[169,321,322],{"class":216},"0.05",[169,324,325],{"class":178},", stages: [op.",[169,327,328],{"class":175},"values",[169,330,331],{"class":178},"(",[169,333,335],{"class":334},"sU2Wk","'write'",[169,337,338],{"class":178},", (",[169,340,341],{"class":182},"f",[169,343,204],{"class":178},[169,345,207],{"class":186},[169,347,348],{"class":178}," paramsU.",[169,350,351],{"class":175},"write",[169,353,354],{"class":178},"({dt: f.dt, radius: f.",[169,356,357],{"class":175},"num",[169,359,331],{"class":178},[169,361,362],{"class":334},"'radius'",[169,364,193],{"class":178},[169,366,367],{"class":216},"0.4",[169,369,370],{"class":178},")})), op.",[169,372,373],{"class":175},"pass",[169,375,376],{"class":178},"(update), op.",[169,378,379],{"class":175},"publish",[169,381,382],{"class":178},"(() ",[169,384,207],{"class":186},[169,386,387],{"class":178}," output)]}))\n",[389,390,391],"blockquote",{},[156,392,393,397],{},[394,395,396],"strong",{},"Tip."," Everything created in the build callback (buffers, passes, trackers) belongs to that layer instance. Create nothing at module scope that holds per-frame state.",[247,399,401],{"id":400},"see-also","See also",[403,404,405,416,428,437,446],"ul",{},[406,407,408,415],"li",{},[409,410,412],"a",{"href":411},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fop",[8,413,414],{},"op"," — The stages a grid frame is built from.",[406,417,418,424,425,235],{},[409,419,421],{"href":420},"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fhostgridprogram",[8,422,423],{},"hostGridProgram"," — A frame program for a small grid stepped in plain JavaScript: the steps run in order every frame until one returns ",[8,426,427],{},"'skip'",[406,429,430,436],{},[409,431,433],{"href":432},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fsimulate",[8,434,435],{},"simulate"," — Declare a simulation the engine runs for you.",[406,438,439,445],{},[409,440,442],{"href":441},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Ffluidsim",[8,443,444],{},"fluidSim"," — A fluid the engine solves every frame.",[406,447,448,454],{},[409,449,451],{"href":450},"\u002Fdocs\u002Fprimitives\u002Fsim-feedback\u002Ffeedbacksim",[8,452,453],{},"feedbackSim"," — A simulation that advances a picture of its own last frame by one step of your rule, every frame.",[247,456,458],{"id":457},"used-by","Used by",[156,460,461,193,465,193,469,193,473],{},[409,462,464],{"href":463},"\u002Fdocs\u002Fcomponents\u002Fgriddistortion","GridDistortion",[409,466,468],{"href":467},"\u002Fdocs\u002Fcomponents\u002Fliquify","Liquify",[409,470,472],{"href":471},"\u002Fdocs\u002Fcomponents\u002Fpixelsort","PixelSort",[409,474,476],{"href":475},"\u002Fdocs\u002Fcomponents\u002Freactiondiffusion","ReactionDiffusion",[478,479,480],"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 .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":165,"searchDepth":482,"depth":482,"links":483},2,[484,485,486,487],{"id":249,"depth":482,"text":250},{"id":290,"depth":482,"text":291},{"id":400,"depth":482,"text":401},{"id":457,"depth":482,"text":458},"sim.grids","sim-grids","Grid programs",false,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-grids\u002Fgridsim",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Fgrids.ts#L126","docs\u002Fprimitives\u002F37.sim-grids\u002F1.gridsim","DRhcNoyixPRj0AmiES4B1FQ6z2nYBX0l7G9_ZglLYyg"]