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