[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fmask\u002Fsoftband":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":229,"categorySlug":229,"categoryTitle":422,"curated":423,"description":158,"editUrl":9,"extension":424,"group":425,"groupTitle":426,"kind":427,"meta":428,"navigation":429,"path":430,"seo":431,"sourceUrl":432,"stem":433,"wordCount":9,"__hash__":434},"primitives\u002Fdocs\u002Fprimitives\u002F21.mask\u002F5.softband.md","softBand",{"type":149,"value":150,"toc":416},"minimark",[151,155,159,224,239,261,266,301,309,312,316,375,379,402,406,412],[152,153,147],"h1",{"id":154},"softband",[156,157,158],"p",{},"A soft band around a line, sharp on one side and long on the other.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","softBand(opts: {\n    distance: Expr\n    below: {from: Expr | number; to: Expr | number}\n    above: {from?: Expr | number; to: Expr | number}\n}): Expr\n","ts","",[8,167,168,180,186,204,218],{"__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","(opts: {\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"    distance: Expr\n",[169,187,189,192,196,199,201],{"class":171,"line":188},3,[169,190,191],{"class":178},"    below: {from: Expr ",[169,193,195],{"class":194},"snl16","|",[169,197,198],{"class":178}," number; to: Expr ",[169,200,195],{"class":194},[169,202,203],{"class":178}," number}\n",[169,205,207,210,212,214,216],{"class":171,"line":206},4,[169,208,209],{"class":178},"    above: {from?: Expr ",[169,211,195],{"class":194},[169,213,198],{"class":178},[169,215,195],{"class":194},[169,217,203],{"class":178},[169,219,221],{"class":171,"line":220},5,[169,222,223],{"class":178},"}): Expr\n",[156,225,226,227,230,231,234,235,238],{},"Import ",[8,228,229],{},"mask"," from ",[8,232,233],{},"shaders\u002Fstd"," and use ",[8,236,237],{},"mask.softBand",".",[156,240,241,244,245,248,249,252,253,256,257,260],{},[8,242,243],{},"distance"," is the signed distance from the line: negative below it, positive above. Coverage rises from 0 to 1 as the distance crosses ",[8,246,247],{},"below.from"," to ",[8,250,251],{},"below.to",", then falls back to 0 as it crosses ",[8,254,255],{},"above.from"," (default 0) to ",[8,258,259],{},"above.to",". The shape under curtains, horizons and underlines.",[262,263,265],"h2",{"id":264},"parameters","Parameters",[267,268,269,285],"table",{},[270,271,272],"thead",{},[273,274,275,279,282],"tr",{},[276,277,278],"th",{},"Name",[276,280,281],{},"Type",[276,283,284],{},"Notes",[286,287,288],"tbody",{},[273,289,290,296,299],{},[291,292,293],"td",{},[8,294,295],{},"opts",[291,297,298],{},"`{",[291,300],{},[160,302,307],{"className":303,"code":305,"language":306},[304],"language-text","distance: Expr\nbelow: {from: Expr \\| number; to: Expr \\| number}\nabove: {from?: Expr \\| number; to: Expr \\| number}\n","text",[8,308,305],{"__ignoreMap":165},[156,310,311],{},"}` |  |",[262,313,315],{"id":314},"example","Example",[160,317,319],{"className":162,"code":318,"language":164,"meta":165,"style":165},"const curtain = mask.softBand({distance: sub(uv.member('y'), pathY), below: {from: -0.04, to: 0.015}, above: {to: height}})\n",[8,320,321],{"__ignoreMap":165},[169,322,323,326,330,333,336,338,341,344,347,350,353,357,360,363,366,369,372],{"class":171,"line":172},[169,324,325],{"class":194},"const",[169,327,329],{"class":328},"sDLfK"," curtain",[169,331,332],{"class":194}," =",[169,334,335],{"class":178}," mask.",[169,337,147],{"class":175},[169,339,340],{"class":178},"({distance: ",[169,342,343],{"class":175},"sub",[169,345,346],{"class":178},"(uv.",[169,348,349],{"class":175},"member",[169,351,352],{"class":178},"(",[169,354,356],{"class":355},"sU2Wk","'y'",[169,358,359],{"class":178},"), pathY), below: {from: ",[169,361,362],{"class":194},"-",[169,364,365],{"class":328},"0.04",[169,367,368],{"class":178},", to: ",[169,370,371],{"class":328},"0.015",[169,373,374],{"class":178},"}, above: {to: height}})\n",[262,376,378],{"id":377},"see-also","See also",[380,381,382,393],"ul",{},[383,384,385,392],"li",{},[386,387,389],"a",{"href":388},"\u002Fdocs\u002Fprimitives\u002Fmask\u002Fsoftdisc",[8,390,391],{},"softDisc"," — A filled disc with a soft, shaped edge.",[383,394,395,401],{},[386,396,398],{"href":397},"\u002Fdocs\u002Fprimitives\u002Fmask\u002Fcrispstroke",[8,399,400],{},"crispStroke"," — A clean outline of a shape, or a drawn curve, of a given width.",[262,403,405],{"id":404},"used-by","Used by",[156,407,408],{},[386,409,411],{"href":410},"\u002Fdocs\u002Fcomponents\u002Faurora","Aurora",[413,414,415],"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":417},[418,419,420,421],{"id":264,"depth":182,"text":265},{"id":314,"depth":182,"text":315},{"id":377,"depth":182,"text":378},{"id":404,"depth":182,"text":405},"Masks",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmask\u002Fsoftband",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fmask.ts#L35","docs\u002Fprimitives\u002F21.mask\u002F5.softband","tFjX6IVS2_WK_eOPOxLtKnbvfqkmGZS9MmXgb3rmO3o"]