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