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