[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fviewray":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":219,"categorySlug":219,"categoryTitle":423,"curated":424,"description":142,"editUrl":425,"extension":426,"group":427,"groupTitle":428,"kind":429,"meta":430,"navigation":431,"path":432,"seo":433,"sourceUrl":434,"stem":435,"wordCount":425,"__hash__":436},"primitives\u002Fdocs\u002Fprimitives\u002F14.materials\u002F23.viewray.md","viewRay",{"type":133,"value":134,"toc":417},"minimark",[135,139,143,214,229,236,241,309,313,335,339,378,382,413],[136,137,131],"h1",{"id":138},"viewray",[140,141,142],"p",{},"The direction the viewer looks along at this pixel, for reflections that sweep across a face.",[144,145,150],"pre",{"className":146,"code":147,"language":148,"meta":149,"style":149},"language-ts shiki shiki-themes github-dark","viewRay(\n  params: GpuFragmentParams,\n  field: Pick\u003CSurfaceField, 'aspect'>,\n  fov: number = 0.6,\n): Expr\n","ts","",[10,151,152,164,170,193,208],{"__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},"  params: GpuFragmentParams,\n",[153,171,173,176,180,183,187,190],{"class":155,"line":172},3,[153,174,175],{"class":162},"  field: Pick",[153,177,179],{"class":178},"snl16","\u003C",[153,181,182],{"class":162},"SurfaceField, ",[153,184,186],{"class":185},"sU2Wk","'aspect'",[153,188,189],{"class":178},">",[153,191,192],{"class":162},",\n",[153,194,196,199,202,206],{"class":155,"line":195},4,[153,197,198],{"class":162},"  fov: number ",[153,200,201],{"class":178},"=",[153,203,205],{"class":204},"sDLfK"," 0.6",[153,207,192],{"class":162},[153,209,211],{"class":155,"line":210},5,[153,212,213],{"class":162},"): Expr\n",[140,215,216,217,220,221,224,225,228],{},"Import ",[10,218,219],{},"materials"," from ",[10,222,223],{},"shaders\u002Fstd"," and use ",[10,226,227],{},"materials.viewRay",".",[140,230,231,232,235],{},"A unit 3D vector pointing into the canvas. ",[10,233,234],{},"fov"," sets how much it leans off-axis toward the edges (0.6 is the usual value, 0.55 flatter).",[237,238,240],"h2",{"id":239},"parameters","Parameters",[242,243,244,260],"table",{},[245,246,247],"thead",{},[248,249,250,254,257],"tr",{},[251,252,253],"th",{},"Name",[251,255,256],{},"Type",[251,258,259],{},"Notes",[261,262,263,278,292],"tbody",{},[248,264,265,271,276],{},[266,267,268],"td",{},[10,269,270],{},"params",[266,272,273],{},[10,274,275],{},"GpuFragmentParams",[266,277],{},[248,279,280,285,290],{},[266,281,282],{},[10,283,284],{},"field",[266,286,287],{},[10,288,289],{},"Pick\u003CSurfaceField, 'aspect'>",[266,291],{},[248,293,294,298,303],{},[266,295,296],{},[10,297,234],{},[266,299,300],{},[10,301,302],{},"number",[266,304,305,306,228],{},"Optional. Default ",[10,307,308],{},"0.6",[237,310,312],{"id":311},"example","Example",[144,314,316],{"className":146,"code":315,"language":148,"meta":149,"style":149},"const view = viewRay(params, field)\n",[10,317,318],{"__ignoreMap":149},[153,319,320,323,326,329,332],{"class":155,"line":156},[153,321,322],{"class":178},"const",[153,324,325],{"class":204}," view",[153,327,328],{"class":178}," =",[153,330,331],{"class":159}," viewRay",[153,333,334],{"class":162},"(params, field)\n",[237,336,338],{"id":337},"see-also","See also",[340,341,342,353,369],"ul",{},[343,344,345,352],"li",{},[346,347,349],"a",{"href":348},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fgrazingof",[10,350,351],{},"grazingOf"," — How edge-on the surface is to the viewer: 0 face-on, 1 grazing.",[343,354,355,361,362,365,366,228],{},[346,356,358],{"href":357},"\u002Fdocs\u002Fprimitives\u002Fmath\u002Freflect",[10,359,360],{},"reflect"," — The direction ",[10,363,364],{},"i"," bounced off a surface with unit normal ",[10,367,368],{},"n",[343,370,371,377],{},[346,372,374],{"href":373},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fstudiosoftboxes",[10,375,376],{},"studioSoftboxes"," — The brightness of a five-light studio seen in a reflected direction.",[237,379,381],{"id":380},"used-by","Used by",[140,383,384,388,389,388,393,388,397,388,401,388,405,388,409],{},[346,385,387],{"href":386},"\u002Fdocs\u002Fcomponents\u002Fbrushedmetal","BrushedMetal",", ",[346,390,392],{"href":391},"\u002Fdocs\u002Fcomponents\u002Fcarbonfiber","CarbonFiber",[346,394,396],{"href":395},"\u002Fdocs\u002Fcomponents\u002Fchrome","Chrome",[346,398,400],{"href":399},"\u002Fdocs\u002Fcomponents\u002Fliquidmetal","LiquidMetal",[346,402,404],{"href":403},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[346,406,408],{"href":407},"\u002Fdocs\u002Fcomponents\u002Fobsidian","Obsidian",[346,410,412],{"href":411},"\u002Fdocs\u002Fcomponents\u002Fsatin","Satin",[414,415,416],"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 pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}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":149,"searchDepth":166,"depth":166,"links":418},[419,420,421,422],{"id":239,"depth":166,"text":240},{"id":311,"depth":166,"text":312},{"id":337,"depth":166,"text":338},{"id":380,"depth":166,"text":381},"Materials & surfaces",false,null,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fviewray",{"title":131,"description":142},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fmaterials.ts#L435","docs\u002Fprimitives\u002F14.materials\u002F23.viewray","QzMQNZ0ewjyqp_zen4M2x9vVgYQWi5CCgF_z_ueh2w0"]