[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fvolumemarch":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":287,"categorySlug":287,"categoryTitle":544,"curated":545,"description":158,"editUrl":9,"extension":546,"group":547,"groupTitle":548,"kind":549,"meta":550,"navigation":551,"path":552,"seo":553,"sourceUrl":554,"stem":555,"wordCount":9,"__hash__":556},"primitives\u002Fdocs\u002Fprimitives\u002F15.volume\u002F2.volumemarch.md","volumeMarch",{"type":149,"value":150,"toc":538},"minimark",[151,155,159,282,297,345,350,385,393,404,408,476,489,493,524,528,534],[152,153,147],"h1",{"id":154},"volumemarch",[156,157,158],"p",{},"Walk a ray through the medium front to back, adding up what glows and what dims.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","volumeMarch(opts: {\n        steps: number\n        entry: Expr\n        length: Expr\n        \u002F** A per-pixel offset added to each step's position along the ray, as a fraction of the ray. *\u002F\n        jitter?: Expr\n        \u002F** A multiplier on every sample's `emit`. *\u002F\n        emissionGain?: Expr\n        hint?: string\n    }, sample: (step: VolumeMarchStep) => {emit: Expr; absorb: Expr}): {color: Expr; transmittance: Expr}\n","ts","",[8,167,168,180,186,192,198,205,218,224,234,245],{"__ignoreMap":165},[169,170,173,176],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(opts: {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"        steps: number\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"        entry: Expr\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"        length: Expr\n",[169,199,201],{"class":171,"line":200},5,[169,202,204],{"class":203},"sAwPA","        \u002F** A per-pixel offset added to each step's position along the ray, as a fraction of the ray. *\u002F\n",[169,206,208,211,215],{"class":171,"line":207},6,[169,209,210],{"class":178},"        jitter",[169,212,214],{"class":213},"snl16","?:",[169,216,217],{"class":178}," Expr\n",[169,219,221],{"class":171,"line":220},7,[169,222,223],{"class":203},"        \u002F** A multiplier on every sample's `emit`. *\u002F\n",[169,225,227,230,232],{"class":171,"line":226},8,[169,228,229],{"class":178},"        emissionGain",[169,231,214],{"class":213},[169,233,217],{"class":178},[169,235,237,240,242],{"class":171,"line":236},9,[169,238,239],{"class":178},"        hint",[169,241,214],{"class":213},[169,243,244],{"class":178}," string\n",[169,246,248,251,255,258,261,264,267,270,273,276,279],{"class":171,"line":247},10,[169,249,250],{"class":178},"    }, sample: (",[169,252,254],{"class":253},"s9osk","step",[169,256,257],{"class":213},":",[169,259,260],{"class":175}," VolumeMarchStep",[169,262,263],{"class":178},") ",[169,265,266],{"class":213},"=>",[169,268,269],{"class":178}," {",[169,271,272],{"class":175},"emit",[169,274,275],{"class":178},": Expr; ",[169,277,278],{"class":175},"absorb",[169,280,281],{"class":178},": Expr}): {color: Expr; transmittance: Expr}\n",[156,283,284,285,288,289,292,293,296],{},"Import ",[8,286,287],{},"volume"," from ",[8,290,291],{},"shaders\u002Fstd"," and use ",[8,294,295],{},"volume.volumeMarch",".",[156,298,299,302,303,306,307,310,311,314,315,317,318,320,321,324,325,328,329,332,333,336,337,340,341,344],{},[8,300,301],{},"steps"," is how many samples to take (4–8 is typical; it is fixed when the shader compiles). ",[8,304,305],{},"entry"," and ",[8,308,309],{},"length"," come from ",[8,312,313],{},"interiorRay",". For each step your callback returns ",[8,316,272],{},", the rgb light this sample gives off, and ",[8,319,278],{},", the rgb amount it blocks. Absorption is per channel, so a medium can dim blue more than red. Returns the accumulated ",[8,322,323],{},"color"," and the ",[8,326,327],{},"transmittance"," left at the far side: multiply anything behind the medium by it. ",[8,330,331],{},"jitter"," is a small per-pixel offset along the ray, as a fraction of its length (a hash times ",[8,334,335],{},"1 \u002F steps"," works), that trades banding for fine grain. ",[8,338,339],{},"emissionGain"," scales every sample's glow; use ",[8,342,343],{},"k \u002F steps"," so brightness does not change with the step count.",[346,347,349],"h2",{"id":348},"parameters","Parameters",[351,352,353,369],"table",{},[354,355,356],"thead",{},[357,358,359,363,366],"tr",{},[360,361,362],"th",{},"Name",[360,364,365],{},"Type",[360,367,368],{},"Notes",[370,371,372],"tbody",{},[357,373,374,380,383],{},[375,376,377],"td",{},[8,378,379],{},"opts",[375,381,382],{},"`{",[375,384],{},[160,386,391],{"className":387,"code":389,"language":390},[388],"language-text","    steps: number\n    entry: Expr\n    length: Expr\n    \u002F** A per-pixel offset added to each step's position along the ray, as a fraction of the ray. *\u002F\n    jitter?: Expr\n    \u002F** A multiplier on every sample's `emit`. *\u002F\n    emissionGain?: Expr\n    hint?: string\n}` |  |\n","text",[8,392,389],{"__ignoreMap":165},[156,394,395,396,399,400,403],{},"| ",[8,397,398],{},"sample"," | ",[8,401,402],{},"(step: VolumeMarchStep) => {emit: Expr; absorb: Expr}"," |  |",[346,405,407],{"id":406},"example","Example",[160,409,411],{"className":162,"code":410,"language":164,"meta":165,"style":165},"const march = volumeMarch({steps: 6, entry: ray.entry, length: ray.length, jitter}, ({z, i}) => ({emit: math.mul(rgb, dens), absorb: math.splat3(math.mul(dens, u.density))}))\n",[8,412,413],{"__ignoreMap":165},[169,414,415,418,422,425,428,431,434,437,439,442,445,448,451,454,456,459,462,465,468,471,473],{"class":171,"line":172},[169,416,417],{"class":213},"const",[169,419,421],{"class":420},"sDLfK"," march",[169,423,424],{"class":213}," =",[169,426,427],{"class":175}," volumeMarch",[169,429,430],{"class":178},"({steps: ",[169,432,433],{"class":420},"6",[169,435,436],{"class":178},", entry: ray.entry, length: ray.",[169,438,309],{"class":420},[169,440,441],{"class":178},", jitter}, ({",[169,443,444],{"class":253},"z",[169,446,447],{"class":178},", ",[169,449,450],{"class":253},"i",[169,452,453],{"class":178},"}) ",[169,455,266],{"class":213},[169,457,458],{"class":178}," ({emit: math.",[169,460,461],{"class":175},"mul",[169,463,464],{"class":178},"(rgb, dens), absorb: math.",[169,466,467],{"class":175},"splat3",[169,469,470],{"class":178},"(math.",[169,472,461],{"class":175},[169,474,475],{"class":178},"(dens, u.density))}))\n",[477,478,479],"blockquote",{},[156,480,481,485,486,488],{},[482,483,484],"strong",{},"Tip."," Fewer steps plus ",[8,487,331],{}," beats more steps: the noise becomes grain instead of bands.",[346,490,492],{"id":491},"see-also","See also",[494,495,496,506,515],"ul",{},[497,498,499,505],"li",{},[500,501,503],"a",{"href":502},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Finteriorray",[8,504,313],{}," — The line of sight through a shape: where it enters, how far it travels inside, and where it is at any depth.",[497,507,508,514],{},[500,509,511],{"href":510},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fturbulentmedium",[8,512,513],{},"turbulentMedium"," — A billowing cloud density at a point inside the shape.",[497,516,517,523],{},[500,518,520],{"href":519},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fparallaxplane",[8,521,522],{},"parallaxPlane"," — A flat layer at a fixed depth inside the shape, like scenery seen through a window.",[346,525,527],{"id":526},"used-by","Used by",[156,529,530],{},[500,531,533],{"href":532},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[535,536,537],"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 .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}html pre.shiki code .snl16, html code.shiki .snl16{--shiki-default:#F97583}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);}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":165,"searchDepth":182,"depth":182,"links":539},[540,541,542,543],{"id":348,"depth":182,"text":349},{"id":406,"depth":182,"text":407},{"id":491,"depth":182,"text":492},{"id":526,"depth":182,"text":527},"Volumes",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fvolumemarch",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fvolume.ts#L194","docs\u002Fprimitives\u002F15.volume\u002F2.volumemarch","C7FBoYpVXui5BWbhZlnMSg7rJff9bs7CpJG1N_JzBW0"]