[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fframes\u002Fcentredframe":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":239,"categorySlug":239,"categoryTitle":437,"curated":438,"description":158,"editUrl":9,"extension":439,"group":440,"groupTitle":441,"kind":442,"meta":443,"navigation":444,"path":445,"seo":446,"sourceUrl":447,"stem":448,"wordCount":9,"__hash__":449},"primitives\u002Fdocs\u002Fprimitives\u002F19.frames\u002F2.centredframe.md","centredFrame",{"type":149,"value":150,"toc":430},"minimark",[151,155,159,234,249,263,268,305,309,356,369,373,416,420,426],[152,153,147],"h1",{"id":154},"centredframe",[156,157,158],"p",{},"A frame centred on a position prop: each pixel's offset from the centre and its distance.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","centredFrame(slots: {center: PropRef}): (params: GpuFragmentParams, surface: { uv: Expr; aspect: Expr; }) => CentredFrame\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184,187,191,193,196,199,202,204,207,210,212,215,218,221,223,225,228,231],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(slots: {center: PropRef})",[169,181,183],{"class":182},"snl16",":",[169,185,186],{"class":178}," (",[169,188,190],{"class":189},"s9osk","params",[169,192,183],{"class":182},[169,194,195],{"class":175}," GpuFragmentParams",[169,197,198],{"class":178},", ",[169,200,201],{"class":189},"surface",[169,203,183],{"class":182},[169,205,206],{"class":178}," { ",[169,208,209],{"class":189},"uv",[169,211,183],{"class":182},[169,213,214],{"class":175}," Expr",[169,216,217],{"class":178},"; ",[169,219,220],{"class":189},"aspect",[169,222,183],{"class":182},[169,224,214],{"class":175},[169,226,227],{"class":178},"; }) ",[169,229,230],{"class":182},"=>",[169,232,233],{"class":178}," CentredFrame\n",[156,235,236,237,240,241,244,245,248],{},"Import ",[8,238,239],{},"frames"," from ",[8,242,243],{},"shaders\u002Fstd"," and use ",[8,246,247],{},"frames.centredFrame",".",[156,250,251,252,255,256,259,260,262],{},"Pass ",[8,253,254],{},"{center: p('center')}"," where ",[8,257,258],{},"center"," is a position prop. Call the result with ",[8,261,190],{}," and a surface. Distances are aspect-corrected, so 1 is the canvas height and a circle stays round on a wide canvas.",[264,265,267],"h2",{"id":266},"parameters","Parameters",[269,270,271,287],"table",{},[272,273,274],"thead",{},[275,276,277,281,284],"tr",{},[278,279,280],"th",{},"Name",[278,282,283],{},"Type",[278,285,286],{},"Notes",[288,289,290],"tbody",{},[275,291,292,298,303],{},[293,294,295],"td",{},[8,296,297],{},"slots",[293,299,300],{},[8,301,302],{},"{center: PropRef}",[293,304],{},[264,306,308],{"id":307},"example","Example",[160,310,312],{"className":162,"code":311,"language":164,"meta":165,"style":165},"const {dist} = centredFrame({center: p('center')})(params, surfaceOf(params))\n",[8,313,314],{"__ignoreMap":165},[169,315,316,319,322,326,329,332,335,338,340,343,347,350,353],{"class":171,"line":172},[169,317,318],{"class":182},"const",[169,320,321],{"class":178}," {",[169,323,325],{"class":324},"sDLfK","dist",[169,327,328],{"class":178},"} ",[169,330,331],{"class":182},"=",[169,333,334],{"class":175}," centredFrame",[169,336,337],{"class":178},"({center: ",[169,339,156],{"class":175},[169,341,342],{"class":178},"(",[169,344,346],{"class":345},"sU2Wk","'center'",[169,348,349],{"class":178},")})(params, ",[169,351,352],{"class":175},"surfaceOf",[169,354,355],{"class":178},"(params))\n",[357,358,359],"blockquote",{},[156,360,361,365,366,368],{},[362,363,364],"strong",{},"Tip."," ",[8,367,325],{}," is in canvas-height units: a radius of 0.5 reaches the top and bottom edges from the middle.",[264,370,372],{"id":371},"see-also","See also",[374,375,376,387,404],"ul",{},[377,378,379,386],"li",{},[380,381,383],"a",{"href":382},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsegmentframe",[8,384,385],{},"segmentFrame"," — A frame along the line between two position props: how far each pixel is along it and across it.",[377,388,389,394,395,397,398,401,402,248],{},[380,390,392],{"href":391},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsurfaceof",[8,393,352],{}," — The canvas a generator paints on: its ",[8,396,209],{},", its ",[8,399,400],{},"viewport"," size in pixels and its ",[8,403,220],{},[377,405,406,412,413,415],{},[380,407,409],{"href":408},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Frawsurfaceof",[8,410,411],{},"rawSurfaceOf"," — The canvas like ",[8,414,352],{},", but always measured against the whole canvas, never a fitted box.",[264,417,419],{"id":418},"used-by","Used by",[156,421,422],{},[380,423,425],{"href":424},"\u002Fdocs\u002Fcomponents\u002Fblob","Blob",[427,428,429],"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 pre.shiki code .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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":431,"depth":431,"links":432},2,[433,434,435,436],{"id":266,"depth":431,"text":267},{"id":307,"depth":431,"text":308},{"id":371,"depth":431,"text":372},{"id":418,"depth":431,"text":419},"Frames & coordinates",false,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fcentredframe",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fframes.ts#L86","docs\u002Fprimitives\u002F19.frames\u002F2.centredframe","7NkWX3A2XdeFqWEcWbBg19fOPoWt19jSOUDphE5DHkc"]