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