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