[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fparallaxplane":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":220,"categorySlug":220,"categoryTitle":415,"curated":416,"description":158,"editUrl":9,"extension":417,"group":418,"groupTitle":419,"kind":420,"meta":421,"navigation":422,"path":423,"seo":424,"sourceUrl":425,"stem":426,"wordCount":9,"__hash__":427},"primitives\u002Fdocs\u002Fprimitives\u002F15.volume\u002F4.parallaxplane.md","parallaxPlane",{"type":149,"value":150,"toc":409},"minimark",[151,155,159,215,230,251,256,307,311,358,368,372,395,399,405],[152,153,147],"h1",{"id":154},"parallaxplane",[156,157,158],"p",{},"A flat layer at a fixed depth inside the shape, like scenery seen through a window.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","parallaxPlane(\n  ray: InteriorRay,\n  opts: {depth: number; pan?: {x: Expr; y: Expr}; panRate?: number; hint?: string},\n): {x: Expr; y: Expr; z: Expr}\n","ts","",[8,167,168,180,186,209],{"__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},"  ray: InteriorRay,\n",[169,187,189,192,196,199,201,204,206],{"class":171,"line":188},3,[169,190,191],{"class":178},"  opts: {depth: number; pan",[169,193,195],{"class":194},"snl16","?:",[169,197,198],{"class":178}," {x: Expr; y: Expr}; panRate",[169,200,195],{"class":194},[169,202,203],{"class":178}," number; hint",[169,205,195],{"class":194},[169,207,208],{"class":178}," string},\n",[169,210,212],{"class":171,"line":211},4,[169,213,214],{"class":178},"): {x: Expr; y: Expr; z: Expr}\n",[156,216,217,218,221,222,225,226,229],{},"Import ",[8,219,220],{},"volume"," from ",[8,223,224],{},"shaders\u002Fstd"," and use ",[8,227,228],{},"volume.parallaxPlane",".",[156,231,232,235,236,239,240,243,244,247,248,229],{},[8,233,234],{},"depth"," is a fraction of the ray's length: 0 at the entry, 1 at the far side, beyond 1 for a backdrop behind the shape. Give it a ",[8,237,238],{},"pan"," (the ",[8,241,242],{},"rotationSensor"," of the frame) and the layer slides as the shape rotates, ",[8,245,246],{},"panRate"," times as far. Deeper layers with higher rates give the parallax of real depth. Returns the position to sample content at, plus its depth ",[8,249,250],{},"z",[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,293],"tbody",{},[263,279,280,286,291],{},[281,282,283],"td",{},[8,284,285],{},"ray",[281,287,288],{},[8,289,290],{},"InteriorRay",[281,292],{},[263,294,295,300,305],{},[281,296,297],{},[8,298,299],{},"opts",[281,301,302],{},[8,303,304],{},"{depth: number; pan?: {x: Expr; y: Expr}; panRate?: number; hint?: string}",[281,306],{},[252,308,310],{"id":309},"example","Example",[160,312,314],{"className":162,"code":313,"language":164,"meta":165,"style":165},"const far = parallaxPlane(ray, {depth: 1.1, pan: rotationSensor(frame), panRate: 1.3, hint: 'far'})\n",[8,315,316],{"__ignoreMap":165},[169,317,318,321,325,328,331,334,337,340,342,345,348,351,355],{"class":171,"line":172},[169,319,320],{"class":194},"const",[169,322,324],{"class":323},"sDLfK"," far",[169,326,327],{"class":194}," =",[169,329,330],{"class":175}," parallaxPlane",[169,332,333],{"class":178},"(ray, {depth: ",[169,335,336],{"class":323},"1.1",[169,338,339],{"class":178},", pan: ",[169,341,242],{"class":175},[169,343,344],{"class":178},"(frame), panRate: ",[169,346,347],{"class":323},"1.3",[169,349,350],{"class":178},", hint: ",[169,352,354],{"class":353},"sU2Wk","'far'",[169,356,357],{"class":178},"})\n",[359,360,361],"blockquote",{},[156,362,363,367],{},[364,365,366],"strong",{},"Tip."," Two planes at different depths and rates are enough to sell a starfield.",[252,369,371],{"id":370},"see-also","See also",[373,374,375,386],"ul",{},[376,377,378,385],"li",{},[379,380,382],"a",{"href":381},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Finteriorray",[8,383,384],{},"interiorRay"," — The line of sight through a shape: where it enters, how far it travels inside, and where it is at any depth.",[376,387,388,394],{},[379,389,391],{"href":390},"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fvolumemarch",[8,392,393],{},"volumeMarch"," — Walk a ray through the medium front to back, adding up what glows and what dims.",[252,396,398],{"id":397},"used-by","Used by",[156,400,401],{},[379,402,404],{"href":403},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[406,407,408],"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}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":182,"depth":182,"links":410},[411,412,413,414],{"id":254,"depth":182,"text":255},{"id":309,"depth":182,"text":310},{"id":370,"depth":182,"text":371},{"id":397,"depth":182,"text":398},"Volumes",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fvolume\u002Fparallaxplane",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fvolume.ts#L94","docs\u002Fprimitives\u002F15.volume\u002F4.parallaxplane","pGAQwIHVOcUee9YOG9ZUluFJglYekdk9JHtBts3PA7w"]