[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fvolume\u002Finteriorray":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":226,"categorySlug":226,"categoryTitle":441,"curated":442,"description":158,"editUrl":9,"extension":443,"group":444,"groupTitle":445,"kind":446,"meta":447,"navigation":448,"path":449,"seo":450,"sourceUrl":451,"stem":452,"wordCount":9,"__hash__":453},"primitives\u002Fdocs\u002Fprimitives\u002F15.volume\u002F1.interiorray.md","interiorRay",{"type":149,"value":150,"toc":435},"minimark",[151,155,159,221,236,267,272,335,339,368,385,389,421,425,431],[152,153,147],"h1",{"id":154},"interiorray",[156,157,158],"p",{},"The line of sight through a shape: where it enters, how far it travels inside, and where it is at any depth.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","interiorRay(\n  field: SurfaceField,\n  frame: SurfaceFrame,\n  opts: {origin: {x: Expr; y: Expr}; view?: Expr; shear?: number; lengthScale?: number},\n): InteriorRay\n","ts","",[8,167,168,180,186,192,215],{"__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","(\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"  field: SurfaceField,\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"  frame: SurfaceFrame,\n",[169,193,195,198,202,205,207,210,212],{"class":171,"line":194},4,[169,196,197],{"class":178},"  opts: {origin: {x: Expr; y: Expr}; view",[169,199,201],{"class":200},"snl16","?:",[169,203,204],{"class":178}," Expr; shear",[169,206,201],{"class":200},[169,208,209],{"class":178}," number; lengthScale",[169,211,201],{"class":200},[169,213,214],{"class":178}," number},\n",[169,216,218],{"class":171,"line":217},5,[169,219,220],{"class":178},"): InteriorRay\n",[156,222,223,224,227,228,231,232,235],{},"Import ",[8,225,226],{},"volume"," from ",[8,229,230],{},"shaders\u002Fstd"," and use ",[8,233,234],{},"volume.interiorRay",".",[156,237,238,239,242,243,246,247,250,251,254,255,258,259,262,263,266],{},"Pass the material's ",[8,240,241],{},"field"," and ",[8,244,245],{},"frame",", the point the ray enters at (",[8,248,249],{},"origin",", usually the shape's centred placement coordinates) and optionally the ",[8,252,253],{},"view"," ray. ",[8,256,257],{},"shear"," (default 1) sets how far deeper samples slide sideways along the view, which is what makes an interior read as deep rather than flat. ",[8,260,261],{},"lengthScale"," stretches or shortens the travel. On a 3D shape ",[8,264,265],{},"length"," is the real chord through it. On a flat shape it stands in for depth, growing toward the middle of the shape.",[268,269,271],"h2",{"id":270},"parameters","Parameters",[273,274,275,291],"table",{},[276,277,278],"thead",{},[279,280,281,285,288],"tr",{},[282,283,284],"th",{},"Name",[282,286,287],{},"Type",[282,289,290],{},"Notes",[292,293,294,308,321],"tbody",{},[279,295,296,301,306],{},[297,298,299],"td",{},[8,300,241],{},[297,302,303],{},[8,304,305],{},"SurfaceField",[297,307],{},[279,309,310,314,319],{},[297,311,312],{},[8,313,245],{},[297,315,316],{},[8,317,318],{},"SurfaceFrame",[297,320],{},[279,322,323,328,333],{},[297,324,325],{},[8,326,327],{},"opts",[297,329,330],{},[8,331,332],{},"{origin: {x: Expr; y: Expr}; view?: Expr; shear?: number; lengthScale?: number}",[297,334],{},[268,336,338],{"id":337},"example","Example",[160,340,342],{"className":162,"code":341,"language":164,"meta":165,"style":165},"const ray = interiorRay(field, frame, {origin: interior, view, shear: 0.55})\n",[8,343,344],{"__ignoreMap":165},[169,345,346,349,353,356,359,362,365],{"class":171,"line":172},[169,347,348],{"class":200},"const",[169,350,352],{"class":351},"sDLfK"," ray",[169,354,355],{"class":200}," =",[169,357,358],{"class":175}," interiorRay",[169,360,361],{"class":178},"(field, frame, {origin: interior, view, shear: ",[169,363,364],{"class":351},"0.55",[169,366,367],{"class":178},"})\n",[369,370,371],"blockquote",{},[156,372,373,377,378,380,381,384],{},[374,375,376],"strong",{},"Tip."," Refract ",[8,379,249],{}," through the shell first (",[8,382,383],{},"shellRefract",") and the interior bends at the glass walls.",[268,386,388],{"id":387},"see-also","See also",[390,391,392,403,412],"ul",{},[393,394,395,402],"li",{},[396,397,399],"a",{"href":398},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fvolumemarch",[8,400,401],{},"volumeMarch"," — Walk a ray through the medium front to back, adding up what glows and what dims.",[393,404,405,411],{},[396,406,408],{"href":407},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fparallaxplane",[8,409,410],{},"parallaxPlane"," — A flat layer at a fixed depth inside the shape, like scenery seen through a window.",[393,413,414,420],{},[396,415,417],{"href":416},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fturbulentmedium",[8,418,419],{},"turbulentMedium"," — A billowing cloud density at a point inside the shape.",[268,422,424],{"id":423},"used-by","Used by",[156,426,427],{},[396,428,430],{"href":429},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[432,433,434],"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 .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}",{"title":165,"searchDepth":182,"depth":182,"links":436},[437,438,439,440],{"id":270,"depth":182,"text":271},{"id":337,"depth":182,"text":338},{"id":387,"depth":182,"text":388},{"id":423,"depth":182,"text":424},"Volumes",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Finteriorray",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fvolume.ts#L48","docs\u002Fprimitives\u002F15.volume\u002F1.interiorray","B_h1ofzIKhSL6Wbj7kdvCaOn8YJF5Y9u9tro0Zt4HAM"]