[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fshape\u002Fring":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":184,"categorySlug":184,"categoryTitle":441,"curated":442,"description":157,"editUrl":9,"extension":443,"group":444,"groupTitle":445,"kind":446,"meta":447,"navigation":448,"path":449,"seo":450,"sourceUrl":451,"stem":452,"wordCount":9,"__hash__":453},"primitives\u002Fdocs\u002Fprimitives\u002F18.shape\u002F8.ring.md","ring",{"type":149,"value":150,"toc":434},"minimark",[151,154,158,179,194,207,212,286,290,370,384,388,420,424,430],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"A ring: a circular band around a centre.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","ring(x: Val, y: Val, radius: Val, thickness: Val): Expr\n","ts","",[8,166,167],{"__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","(x: Val, y: Val, radius: Val, thickness: Val): Expr\n",[155,180,181,182,185,186,189,190,193],{},"Import ",[8,183,184],{},"shape"," from ",[8,187,188],{},"shaders\u002Fstd"," and use ",[8,191,192],{},"shape.ring",".",[155,195,196,199,200,203,204,206],{},[8,197,198],{},"radius"," is the distance to the middle of the band, ",[8,201,202],{},"thickness"," half the band's width, both in uv. The full band is twice ",[8,205,202],{}," wide.",[208,209,211],"h2",{"id":210},"parameters","Parameters",[213,214,215,231],"table",{},[216,217,218],"thead",{},[219,220,221,225,228],"tr",{},[222,223,224],"th",{},"Name",[222,226,227],{},"Type",[222,229,230],{},"Notes",[232,233,234,249,262,274],"tbody",{},[219,235,236,242,247],{},[237,238,239],"td",{},[8,240,241],{},"x",[237,243,244],{},[8,245,246],{},"Val",[237,248],{},[219,250,251,256,260],{},[237,252,253],{},[8,254,255],{},"y",[237,257,258],{},[8,259,246],{},[237,261],{},[219,263,264,268,272],{},[237,265,266],{},[8,267,198],{},[237,269,270],{},[8,271,246],{},[237,273],{},[219,275,276,280,284],{},[237,277,278],{},[8,279,202],{},[237,281,282],{},[8,283,246],{},[237,285],{},[208,287,289],{"id":288},"example","Example",[159,291,293],{"className":161,"code":292,"language":163,"meta":164,"style":164},"shape: {distance: ({x, y}, u) => ring(x, y, u('radius'), u('thickness')), rotatable: false, …}\n",[8,294,295],{"__ignoreMap":164},[168,296,297,299,302,305,308,311,314,316,319,322,325,329,332,335,337,340,344,347,349,351,354,357,360,363,367],{"class":170,"line":171},[168,298,184],{"class":174},[168,300,301],{"class":177},": {",[168,303,304],{"class":174},"distance",[168,306,307],{"class":177},": ({",[168,309,241],{"class":310},"s9osk",[168,312,313],{"class":177},", ",[168,315,255],{"class":310},[168,317,318],{"class":177},"}, ",[168,320,321],{"class":310},"u",[168,323,324],{"class":177},") ",[168,326,328],{"class":327},"snl16","=>",[168,330,331],{"class":174}," ring",[168,333,334],{"class":177},"(x, y, ",[168,336,321],{"class":174},[168,338,339],{"class":177},"(",[168,341,343],{"class":342},"sU2Wk","'radius'",[168,345,346],{"class":177},"), ",[168,348,321],{"class":174},[168,350,339],{"class":177},[168,352,353],{"class":342},"'thickness'",[168,355,356],{"class":177},")), ",[168,358,359],{"class":174},"rotatable",[168,361,362],{"class":177},": ",[168,364,366],{"class":365},"sDLfK","false",[168,368,369],{"class":177},", …}\n",[371,372,373],"blockquote",{},[155,374,375,379,380,383],{},[376,377,378],"strong",{},"Tip."," Rotationally symmetric, so declare ",[8,381,382],{},"rotatable: false"," and the rotation prop is left out.",[208,385,387],{"id":386},"see-also","See also",[389,390,391,402,411],"ul",{},[392,393,394,401],"li",{},[395,396,398],"a",{"href":397},"\u002Fdocs\u002Fprimitives\u002Fshape\u002Fcircle",[8,399,400],{},"circle"," — A circle of a given radius.",[392,403,404,410],{},[395,405,407],{"href":406},"\u002Fdocs\u002Fprimitives\u002Fshape\u002Farc",[8,408,409],{},"arc"," — A pie wedge: a filled sector of a circle.",[392,412,413,419],{},[395,414,416],{"href":415},"\u002Fdocs\u002Fprimitives\u002Fshape\u002Fcrescent",[8,417,418],{},"crescent"," — A crescent: a disc with a smaller disc bitten out of it.",[208,421,423],{"id":422},"used-by","Used by",[155,425,426],{},[395,427,429],{"href":428},"\u002Fdocs\u002Fcomponents\u002Fring","Ring",[431,432,433],"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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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}",{"title":164,"searchDepth":435,"depth":435,"links":436},2,[437,438,439,440],{"id":210,"depth":435,"text":211},{"id":288,"depth":435,"text":289},{"id":386,"depth":435,"text":387},{"id":422,"depth":435,"text":423},"Shapes",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fshape\u002Fring",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fshape.ts#L158","docs\u002Fprimitives\u002F18.shape\u002F8.ring","gvPOnL03xYe17NWhMEci9Yssq9P0av_WmXQjbTpHk58"]