[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fsplat":129},{"stars":4},5505,[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":393,"categorySlug":394,"categoryTitle":395,"curated":396,"description":141,"editUrl":397,"extension":398,"group":399,"groupTitle":400,"kind":401,"meta":402,"navigation":403,"path":404,"seo":405,"sourceUrl":406,"stem":407,"wordCount":397,"__hash__":408},"primitives\u002Fdocs\u002Fprimitives\u002F38.sim-fluids\u002F2.splat.md","splat",{"type":133,"value":134,"toc":386},"minimark",[135,138,142,242,257,263,268,304,308,326,340,344,367,371,382],[136,137,131],"h1",{"id":131},[139,140,141],"p",{},"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).",[143,144,149],"pre",{"className":145,"code":146,"language":147,"meta":148,"style":148},"language-ts shiki shiki-themes github-dark","splat\u003CTParams = unknown>(opts: {kernel: FluidKernel} | {setup: (ctx: FluidSetupCtx) => KitComputePipeline}): FluidEmitter\u003CTParams>\n","ts","",[10,150,151],{"__ignoreMap":148},[152,153,156,160,164,168,172,175,179,182,185,188,190,193,196,199,201,204,206,209,212,214,217,220,223,226,229,231,234,237,239],"span",{"class":154,"line":155},"line",1,[152,157,159],{"class":158},"s95oV","splat\u003C",[152,161,163],{"class":162},"svObZ","TParams",[152,165,167],{"class":166},"snl16"," =",[152,169,171],{"class":170},"sDLfK"," unknown",[152,173,174],{"class":158},">(",[152,176,178],{"class":177},"s9osk","opts",[152,180,181],{"class":166},":",[152,183,184],{"class":158}," {",[152,186,187],{"class":177},"kernel",[152,189,181],{"class":166},[152,191,192],{"class":162}," FluidKernel",[152,194,195],{"class":158},"} ",[152,197,198],{"class":166},"|",[152,200,184],{"class":158},[152,202,203],{"class":162},"setup",[152,205,181],{"class":166},[152,207,208],{"class":158}," (",[152,210,211],{"class":177},"ctx",[152,213,181],{"class":166},[152,215,216],{"class":162}," FluidSetupCtx",[152,218,219],{"class":158},") ",[152,221,222],{"class":166},"=>",[152,224,225],{"class":162}," KitComputePipeline",[152,227,228],{"class":158},"})",[152,230,181],{"class":166},[152,232,233],{"class":162}," FluidEmitter",[152,235,236],{"class":158},"\u003C",[152,238,163],{"class":162},[152,240,241],{"class":158},">\n",[139,243,244,245,248,249,252,253,256],{},"Import ",[10,246,247],{},"sim"," from ",[10,250,251],{},"shaders\u002Fstd"," and use ",[10,254,255],{},"sim.fluids.splat",".",[139,258,259,260,262],{},"Give it the pass function, or a ",[10,261,203],{}," that builds the pass on resources of its own.",[264,265,267],"h2",{"id":266},"parameters","Parameters",[269,270,271,287],"table",{},[272,273,274],"thead",{},[275,276,277,281,284],"tr",{},[278,279,280],"th",{},"Name",[278,282,283],{},"Type",[278,285,286],{},"Notes",[288,289,290],"tbody",{},[275,291,292,297,302],{},[293,294,295],"td",{},[10,296,178],{},[293,298,299],{},[10,300,301],{},"{kernel: FluidKernel} | {setup: (ctx: FluidSetupCtx) => KitComputePipeline}",[293,303],{},[264,305,307],{"id":306},"example","Example",[143,309,311],{"className":145,"code":310,"language":147,"meta":148,"style":148},"inject: [splat({kernel: splatKernel})]\n",[10,312,313],{"__ignoreMap":148},[152,314,315,318,321,323],{"class":154,"line":155},[152,316,317],{"class":162},"inject",[152,319,320],{"class":158},": [",[152,322,131],{"class":162},[152,324,325],{"class":158},"({kernel: splatKernel})]\n",[327,328,329],"blockquote",{},[139,330,331,335,336,339],{},[332,333,334],"strong",{},"Tip."," The source position and radius come from ",[10,337,338],{},"values",", in grid cells.",[264,341,343],{"id":342},"see-also","See also",[345,346,347,358],"ul",{},[348,349,350,357],"li",{},[351,352,354],"a",{"href":353},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fcursorribbon",[10,355,356],{},"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.",[348,359,360,366],{},[351,361,363],{"href":362},"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Ffluidsim",[10,364,365],{},"fluidSim"," — A fluid the engine solves every frame.",[264,368,370],{"id":369},"used-by","Used by",[139,372,373,377,378],{},[351,374,376],{"href":375},"\u002Fdocs\u002Fcomponents\u002Fsmoke","Smoke",", ",[351,379,381],{"href":380},"\u002Fdocs\u002Fcomponents\u002Fsmokefill","SmokeFill",[383,384,385],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}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 pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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);}",{"title":148,"searchDepth":387,"depth":387,"links":388},2,[389,390,391,392],{"id":266,"depth":387,"text":267},{"id":306,"depth":387,"text":307},{"id":342,"depth":387,"text":343},{"id":369,"depth":387,"text":370},"sim.fluids","sim-fluids","Fluids",false,null,"md","simulation","Simulation","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fsim-fluids\u002Fsplat",{"title":131,"description":141},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fsim\u002Ffluids.ts#L366","docs\u002Fprimitives\u002F38.sim-fluids\u002F2.splat","YBC8NisHh73QzMD1qmzHG-5NwqKoGVSY0-4sn2C1HYo"]