[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Ffluidsim":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":557,"categorySlug":558,"categoryTitle":559,"curated":560,"description":142,"editUrl":561,"extension":562,"group":563,"groupTitle":564,"kind":565,"meta":566,"navigation":567,"path":568,"seo":569,"sourceUrl":570,"stem":571,"wordCount":561,"__hash__":572},"primitives\u002Fdocs\u002Fprimitives\u002F38.sim-fluids\u002F1.fluidsim.md","fluidSim",{"type":133,"value":134,"toc":550},"minimark",[135,139,143,211,226,236,243,248,285,289,438,454,458,520,524,546],[136,137,131],"h1",{"id":138},"fluidsim",[140,141,142],"p",{},"A fluid the engine solves every frame.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"language-ts shiki shiki-themes github-dark","fluidSim\u003CTParams>(build: (params: GpuFragmentParams, root: FluidRoot) => FluidSimConfig\u003CTParams>): {compute: GpuComputeNode}\n","ts","",[10,151,152],{"__ignoreMap":149},[153,154,157,160,164,167,170,174,178,181,184,187,189,192,195,198,201,203,205,208],"span",{"class":155,"line":156},"line",1,[153,158,131],{"class":159},"svObZ",[153,161,163],{"class":162},"s95oV","\u003C",[153,165,166],{"class":159},"TParams",[153,168,169],{"class":162},">(build: (",[153,171,173],{"class":172},"s9osk","params",[153,175,177],{"class":176},"snl16",":",[153,179,180],{"class":159}," GpuFragmentParams",[153,182,183],{"class":162},", ",[153,185,186],{"class":172},"root",[153,188,177],{"class":176},[153,190,191],{"class":159}," FluidRoot",[153,193,194],{"class":162},") ",[153,196,197],{"class":176},"=>",[153,199,200],{"class":162}," FluidSimConfig",[153,202,163],{"class":176},[153,204,166],{"class":162},[153,206,207],{"class":176},">",[153,209,210],{"class":162},"): {compute: GpuComputeNode}\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.fluids.fluidSim",".",[140,227,228,229,232,233,225],{},"Spread it into a definition next to a ",[10,230,231],{},"gpu.fragment"," that samples the output texture under ",[10,234,235],{},"output.key",[140,237,238,239,242],{},"The build callback runs once per instance of the layer, with the GPU device, and returns the grid size, the solver, the output pass, the parts and the ",[10,240,241],{},"values"," function. Everything created inside it belongs to that instance. Without a GPU nothing runs and the fragment should fall back to transparent.",[244,245,247],"h2",{"id":246},"parameters","Parameters",[249,250,251,267],"table",{},[252,253,254],"thead",{},[255,256,257,261,264],"tr",{},[258,259,260],"th",{},"Name",[258,262,263],{},"Type",[258,265,266],{},"Notes",[268,269,270],"tbody",{},[255,271,272,278,283],{},[273,274,275],"td",{},[10,276,277],{},"build",[273,279,280],{},[10,281,282],{},"(params: GpuFragmentParams, root: FluidRoot) => FluidSimConfig\u003CTParams>",[273,284],{},[244,286,288],{"id":287},"example","Example",[144,290,292],{"className":146,"code":291,"language":148,"meta":149,"style":149},"...fluidSim(() => ({resolution: 256, layout: fluidLayout, outputLayout, paramsSchema: FluidParams, solver: {kernels: solverKernels, jacobiIters: 10}, output: {kernel: outputKernel, key: 'smokeTexture'}, pointer: {minDrag: 0.0005}, inject: [splat({kernel: splatKernel})], values: (f) => ({dt: f.dt, emitX: 0.5 * 256, emitY: 256, emitRad: f.num('emitRadius', 0.06) * 256, dyeFade: f.num('dissipation', 1), velFade: 0.2, curlStrength: f.num('detail', 30), colorDecay: 1})}))\n",[10,293,294],{"__ignoreMap":149},[153,295,296,299,301,304,306,309,313,316,319,322,326,329,332,335,338,341,343,346,349,351,353,356,359,362,365,368,370,373,376,379,382,384,387,389,392,394,397,399,401,404,406,409,412,415,418,420,422,425,427,430,433,435],{"class":155,"line":156},[153,297,298],{"class":176},"...",[153,300,131],{"class":159},[153,302,303],{"class":162},"(() ",[153,305,197],{"class":176},[153,307,308],{"class":162}," ({resolution: ",[153,310,312],{"class":311},"sDLfK","256",[153,314,315],{"class":162},", layout: fluidLayout, outputLayout, paramsSchema: FluidParams, solver: {kernels: solverKernels, jacobiIters: ",[153,317,318],{"class":311},"10",[153,320,321],{"class":162},"}, output: {kernel: outputKernel, key: ",[153,323,325],{"class":324},"sU2Wk","'smokeTexture'",[153,327,328],{"class":162},"}, pointer: {minDrag: ",[153,330,331],{"class":311},"0.0005",[153,333,334],{"class":162},"}, inject: [",[153,336,337],{"class":159},"splat",[153,339,340],{"class":162},"({kernel: splatKernel})], ",[153,342,241],{"class":159},[153,344,345],{"class":162},": (",[153,347,348],{"class":172},"f",[153,350,194],{"class":162},[153,352,197],{"class":176},[153,354,355],{"class":162}," ({dt: f.dt, emitX: ",[153,357,358],{"class":311},"0.5",[153,360,361],{"class":176}," *",[153,363,364],{"class":311}," 256",[153,366,367],{"class":162},", emitY: ",[153,369,312],{"class":311},[153,371,372],{"class":162},", emitRad: f.",[153,374,375],{"class":159},"num",[153,377,378],{"class":162},"(",[153,380,381],{"class":324},"'emitRadius'",[153,383,183],{"class":162},[153,385,386],{"class":311},"0.06",[153,388,194],{"class":162},[153,390,391],{"class":176},"*",[153,393,364],{"class":311},[153,395,396],{"class":162},", dyeFade: f.",[153,398,375],{"class":159},[153,400,378],{"class":162},[153,402,403],{"class":324},"'dissipation'",[153,405,183],{"class":162},[153,407,408],{"class":311},"1",[153,410,411],{"class":162},"), velFade: ",[153,413,414],{"class":311},"0.2",[153,416,417],{"class":162},", curlStrength: f.",[153,419,375],{"class":159},[153,421,378],{"class":162},[153,423,424],{"class":324},"'detail'",[153,426,183],{"class":162},[153,428,429],{"class":311},"30",[153,431,432],{"class":162},"), colorDecay: ",[153,434,408],{"class":311},[153,436,437],{"class":162},"})}))\n",[439,440,441],"blockquote",{},[140,442,443,447,448,450,451,225],{},[444,445,446],"strong",{},"Tip."," Positions and radii in ",[10,449,241],{}," are in grid cells, not uv: multiply a uv value by ",[10,452,453],{},"resolution",[244,455,457],{"id":456},"see-also","See also",[459,460,461,471,480,493,502,511],"ul",{},[462,463,464,470],"li",{},[465,466,468],"a",{"href":467},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fsplat",[10,469,337],{}," — An emitter at a fixed source: one pass per frame that adds dye and momentum where your pass function says (a cone from a point, a line along an edge).",[462,472,473,479],{},[465,474,476],{"href":475},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fcursorribbon",[10,477,478],{},"cursorRibbon"," — An emitter that paints along the pointer's stroke: a ribbon of stamps between last frame's position and this one, so a fast flick leaves a continuous line, not dots.",[462,481,482,488,489,492],{},[465,483,485],{"href":484},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fseededfieldinit",[10,486,487],{},"seededFieldInit"," — A field that starts full: seed it from a pass function, then run the solve silently ",[10,490,491],{},"warm.steps"," times so the first visible frame already flows.",[462,494,495,501],{},[465,496,498],{"href":497},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fambientforce",[10,499,500],{},"ambientForce"," — A force applied to the whole field before every solve: a turbulence field, a steady wind.",[462,503,504,510],{},[465,505,507],{"href":506},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Frestoretoward",[10,508,509],{},"restoreToward"," — A correction applied after every solve: re-seed a color that the solve slowly blurs away.",[462,512,513,519],{},[465,514,516],{"href":515},"\u002Fdocs\u002Fprimitives\u002Fsimulate\u002Fsimulate",[10,517,518],{},"simulate"," — Declare a simulation the engine runs for you.",[244,521,523],{"id":522},"used-by","Used by",[140,525,526,183,530,183,534,183,538,183,542],{},[465,527,529],{"href":528},"\u002Fdocs\u002Fcomponents\u002Ffog","Fog",[465,531,533],{"href":532},"\u002Fdocs\u002Fcomponents\u002Finkflow","InkFlow",[465,535,537],{"href":536},"\u002Fdocs\u002Fcomponents\u002Fsmoke","Smoke",[465,539,541],{"href":540},"\u002Fdocs\u002Fcomponents\u002Fsmokefill","SmokeFill",[465,543,545],{"href":544},"\u002Fdocs\u002Fcomponents\u002Fsmokeflow","SmokeFlow",[547,548,549],"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 .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":149,"searchDepth":551,"depth":551,"links":552},2,[553,554,555,556],{"id":246,"depth":551,"text":247},{"id":287,"depth":551,"text":288},{"id":456,"depth":551,"text":457},{"id":522,"depth":551,"text":523},"sim.fluids","sim-fluids","Fluids",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Ffluidsim",{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Ffluids.ts#L240","docs\u002Fprimitives\u002F38.sim-fluids\u002F1.fluidsim","vrSIUCfr-IetlBq6VmRhflB-EPJ5gmmeA5z-iXemk8o"]