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