[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Flight\u002Flightbeam":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":215,"categorySlug":215,"categoryTitle":456,"curated":457,"description":158,"editUrl":9,"extension":458,"group":215,"groupTitle":459,"kind":460,"meta":461,"navigation":462,"path":463,"seo":464,"sourceUrl":465,"stem":466,"wordCount":9,"__hash__":467},"primitives\u002Fdocs\u002Fprimitives\u002F13.light\u002F29.lightbeam.md","lightBeam",{"type":149,"value":150,"toc":451},"minimark",[151,155,159,210,225,252,257,334,338,424,428,447],[152,153,147],"h1",{"id":154},"lightbeam",[156,157,158],"p",{},"The glow of a beam that can be thicker or softer at one end than the other.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","lightBeam(\n  dist: Expr,\n  t: Expr,\n  thickness: {start: Expr; end: Expr},\n  softness: {start: Expr; end: Expr},\n): Expr\n","ts","",[8,167,168,180,186,192,198,204],{"__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},"  dist: Expr,\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"  t: Expr,\n",[169,193,195],{"class":171,"line":194},4,[169,196,197],{"class":178},"  thickness: {start: Expr; end: Expr},\n",[169,199,201],{"class":171,"line":200},5,[169,202,203],{"class":178},"  softness: {start: Expr; end: Expr},\n",[169,205,207],{"class":171,"line":206},6,[169,208,209],{"class":178},"): Expr\n",[156,211,212,213,216,217,220,221,224],{},"Import ",[8,214,215],{},"light"," from ",[8,218,219],{},"shaders\u002Fstd"," and use ",[8,222,223],{},"light.lightBeam",".",[156,226,227,228,231,232,235,236,239,240,243,244,247,248,251],{},"Give it the distance from the line and the position along it from ",[8,229,230],{},"segmentProject",". Thickness and softness blend from ",[8,233,234],{},"start"," to ",[8,237,238],{},"end"," along the beam, in the distance unit. Returns ",[8,241,242],{},"vec2(colorT, alpha)",": ",[8,245,246],{},"alpha"," is 1 inside the beam and fades to 0 outside, and ",[8,249,250],{},"colorT"," runs 0 at the core to 1 at the edge so you can shade the two differently.",[253,254,256],"h2",{"id":255},"parameters","Parameters",[258,259,260,276],"table",{},[261,262,263],"thead",{},[264,265,266,270,273],"tr",{},[267,268,269],"th",{},"Name",[267,271,272],{},"Type",[267,274,275],{},"Notes",[277,278,279,294,307,321],"tbody",{},[264,280,281,287,292],{},[282,283,284],"td",{},[8,285,286],{},"dist",[282,288,289],{},[8,290,291],{},"Expr",[282,293],{},[264,295,296,301,305],{},[282,297,298],{},[8,299,300],{},"t",[282,302,303],{},[8,304,291],{},[282,306],{},[264,308,309,314,319],{},[282,310,311],{},[8,312,313],{},"thickness",[282,315,316],{},[8,317,318],{},"{start: Expr; end: Expr}",[282,320],{},[264,322,323,328,332],{},[282,324,325],{},[8,326,327],{},"softness",[282,329,330],{},[8,331,318],{},[282,333],{},[253,335,337],{"id":336},"example","Example",[160,339,341],{"className":162,"code":340,"language":164,"meta":165,"style":165},"const beam = lightBeam(seg.member('y'), seg.member('x'), {start: p('startThickness'), end: p('endThickness')}, {start: p('startSoftness'), end: p('endSoftness')})\n",[8,342,343],{"__ignoreMap":165},[169,344,345,349,353,356,359,362,365,368,372,375,377,379,382,385,387,389,392,395,397,399,402,405,407,409,412,414,416,418,421],{"class":171,"line":172},[169,346,348],{"class":347},"snl16","const",[169,350,352],{"class":351},"sDLfK"," beam",[169,354,355],{"class":347}," =",[169,357,358],{"class":175}," lightBeam",[169,360,361],{"class":178},"(seg.",[169,363,364],{"class":175},"member",[169,366,367],{"class":178},"(",[169,369,371],{"class":370},"sU2Wk","'y'",[169,373,374],{"class":178},"), seg.",[169,376,364],{"class":175},[169,378,367],{"class":178},[169,380,381],{"class":370},"'x'",[169,383,384],{"class":178},"), {start: ",[169,386,156],{"class":175},[169,388,367],{"class":178},[169,390,391],{"class":370},"'startThickness'",[169,393,394],{"class":178},"), end: ",[169,396,156],{"class":175},[169,398,367],{"class":178},[169,400,401],{"class":370},"'endThickness'",[169,403,404],{"class":178},")}, {start: ",[169,406,156],{"class":175},[169,408,367],{"class":178},[169,410,411],{"class":370},"'startSoftness'",[169,413,394],{"class":178},[169,415,156],{"class":175},[169,417,367],{"class":178},[169,419,420],{"class":370},"'endSoftness'",[169,422,423],{"class":178},")})\n",[253,425,427],{"id":426},"see-also","See also",[429,430,431],"ul",{},[432,433,434,440,441,235,443,446],"li",{},[435,436,438],"a",{"href":437},"\u002Fdocs\u002Fprimitives\u002Flight\u002Fsegmentproject",[8,439,230],{}," — Where a pixel falls along a line from ",[8,442,435],{},[8,444,445],{},"b",", and how far it is from that line.",[448,449,450],"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 .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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}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":452},[453,454,455],{"id":255,"depth":182,"text":256},{"id":336,"depth":182,"text":337},{"id":426,"depth":182,"text":427},"Light",false,"md","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Flight\u002Flightbeam",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Flight.ts#L606","docs\u002Fprimitives\u002F13.light\u002F29.lightbeam","QQEJhmh8aNJlXhJsSDOrpZYPnqxTNdDvN1akOno6WDA"]