[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fgradients\u002Fbeam":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":494,"curated":495,"description":157,"editUrl":9,"extension":496,"group":349,"groupTitle":497,"kind":498,"meta":499,"navigation":500,"path":501,"seo":502,"sourceUrl":503,"stem":504,"wordCount":9,"__hash__":505},"primitives\u002Fdocs\u002Fprimitives\u002F7.gradients\u002F2.beam.md","beam",{"type":149,"value":150,"toc":488},"minimark",[151,154,158,221,236,285,290,325,333,336,340,449,453,474,478,484],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"A glowing beam of light between two points.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","beam(slots: {\n    from: PropRef\n    to: PropRef\n    thickness: {start: ArgSpec; end: ArgSpec}\n    softness: {start: ArgSpec; end: ArgSpec}\n    colors: {inside: PropRef; outside: PropRef}\n    space: PropRef\n}): Paint\n","ts","",[8,166,167,179,185,191,197,203,209,215],{"__ignoreMap":164},[168,169,172,175],"span",{"class":170,"line":171},"line",1,[168,173,147],{"class":174},"svObZ",[168,176,178],{"class":177},"s95oV","(slots: {\n",[168,180,182],{"class":170,"line":181},2,[168,183,184],{"class":177},"    from: PropRef\n",[168,186,188],{"class":170,"line":187},3,[168,189,190],{"class":177},"    to: PropRef\n",[168,192,194],{"class":170,"line":193},4,[168,195,196],{"class":177},"    thickness: {start: ArgSpec; end: ArgSpec}\n",[168,198,200],{"class":170,"line":199},5,[168,201,202],{"class":177},"    softness: {start: ArgSpec; end: ArgSpec}\n",[168,204,206],{"class":170,"line":205},6,[168,207,208],{"class":177},"    colors: {inside: PropRef; outside: PropRef}\n",[168,210,212],{"class":170,"line":211},7,[168,213,214],{"class":177},"    space: PropRef\n",[168,216,218],{"class":170,"line":217},8,[168,219,220],{"class":177},"}): Paint\n",[155,222,223,224,227,228,231,232,235],{},"Import ",[8,225,226],{},"gradients"," from ",[8,229,230],{},"shaders\u002Fstd"," and use ",[8,233,234],{},"gradients.beam",".",[155,237,238,241,242,245,246,249,250,253,254,257,258,241,261,264,265,268,269,272,273,276,277,280,281,284],{},[8,239,240],{},"from"," and ",[8,243,244],{},"to"," are position props (made with ",[8,247,248],{},"transformPosition","). ",[8,251,252],{},"thickness"," (0–2) and ",[8,255,256],{},"softness"," each take a ",[8,259,260],{},"start",[8,262,263],{},"end"," value so the beam can taper. The cross-section shades from ",[8,266,267],{},"colors.inside"," at the core to ",[8,270,271],{},"colors.outside"," at the edge, mixed in the color space named by the ",[8,274,275],{},"space"," prop (mark it ",[8,278,279],{},"compileTime","). Declare ",[8,282,283],{},"extraFields: beamPreconvertedFields"," on the definition.",[286,287,289],"h2",{"id":288},"parameters","Parameters",[291,292,293,309],"table",{},[294,295,296],"thead",{},[297,298,299,303,306],"tr",{},[300,301,302],"th",{},"Name",[300,304,305],{},"Type",[300,307,308],{},"Notes",[310,311,312],"tbody",{},[297,313,314,320,323],{},[315,316,317],"td",{},[8,318,319],{},"slots",[315,321,322],{},"`{",[315,324],{},[159,326,331],{"className":327,"code":329,"language":330},[328],"language-text","from: PropRef\nto: PropRef\nthickness: {start: ArgSpec; end: ArgSpec}\nsoftness: {start: ArgSpec; end: ArgSpec}\ncolors: {inside: PropRef; outside: PropRef}\nspace: PropRef\n","text",[8,332,329],{"__ignoreMap":164},[155,334,335],{},"}` |  |",[286,337,339],{"id":338},"example","Example",[159,341,343],{"className":161,"code":342,"language":163,"meta":164,"style":164},"paint: beam({from: p('startPosition'), to: p('endPosition'), thickness: {start: p('startThickness'), end: p('endThickness')}, softness: {start: p('startSoftness'), end: p('endSoftness')}, colors: {inside: p('insideColor'), outside: p('outsideColor')}, space: p('colorSpace')})\n",[8,344,345],{"__ignoreMap":164},[168,346,347,350,353,355,358,360,363,367,370,372,374,377,380,382,384,387,390,392,394,397,400,402,404,407,409,411,413,416,419,421,423,426,429,431,433,436,439,441,443,446],{"class":170,"line":171},[168,348,349],{"class":174},"paint",[168,351,352],{"class":177},": ",[168,354,147],{"class":174},[168,356,357],{"class":177},"({from: ",[168,359,155],{"class":174},[168,361,362],{"class":177},"(",[168,364,366],{"class":365},"sU2Wk","'startPosition'",[168,368,369],{"class":177},"), to: ",[168,371,155],{"class":174},[168,373,362],{"class":177},[168,375,376],{"class":365},"'endPosition'",[168,378,379],{"class":177},"), thickness: {start: ",[168,381,155],{"class":174},[168,383,362],{"class":177},[168,385,386],{"class":365},"'startThickness'",[168,388,389],{"class":177},"), end: ",[168,391,155],{"class":174},[168,393,362],{"class":177},[168,395,396],{"class":365},"'endThickness'",[168,398,399],{"class":177},")}, softness: {start: ",[168,401,155],{"class":174},[168,403,362],{"class":177},[168,405,406],{"class":365},"'startSoftness'",[168,408,389],{"class":177},[168,410,155],{"class":174},[168,412,362],{"class":177},[168,414,415],{"class":365},"'endSoftness'",[168,417,418],{"class":177},")}, colors: {inside: ",[168,420,155],{"class":174},[168,422,362],{"class":177},[168,424,425],{"class":365},"'insideColor'",[168,427,428],{"class":177},"), outside: ",[168,430,155],{"class":174},[168,432,362],{"class":177},[168,434,435],{"class":365},"'outsideColor'",[168,437,438],{"class":177},")}, space: ",[168,440,155],{"class":174},[168,442,362],{"class":177},[168,444,445],{"class":365},"'colorSpace'",[168,447,448],{"class":177},")})\n",[286,450,452],{"id":451},"see-also","See also",[454,455,456],"ul",{},[457,458,459,466,467,470,471,473],"li",{},[460,461,463],"a",{"href":462},"\u002Fdocs\u002Fprimitives\u002Fgradients\u002Fbeampreconvertedfields",[8,464,465],{},"beamPreconvertedFields"," — The ",[8,468,469],{},"extraFields"," a ",[8,472,147],{}," definition must declare.",[286,475,477],{"id":476},"used-by","Used by",[155,479,480],{},[460,481,483],{"href":482},"\u002Fdocs\u002Fcomponents\u002Fbeam","Beam",[485,486,487],"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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":164,"searchDepth":181,"depth":181,"links":489},[490,491,492,493],{"id":288,"depth":181,"text":289},{"id":338,"depth":181,"text":339},{"id":451,"depth":181,"text":452},{"id":476,"depth":181,"text":477},"Gradients",false,"md","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fgradients\u002Fbeam",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fgradients.ts#L194","docs\u002Fprimitives\u002F7.gradients\u002F2.beam","ZFHdyUqJYosu-9FmcMTQnteFc80b3_GmBG-PH-zUAug"]