[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fframes\u002Frawsurfaceof":129},{"stars":4},5505,[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":173,"categorySlug":173,"categoryTitle":334,"curated":335,"description":336,"editUrl":337,"extension":338,"group":339,"groupTitle":340,"kind":341,"meta":342,"navigation":343,"path":344,"seo":345,"sourceUrl":346,"stem":347,"wordCount":337,"__hash__":348},"primitives\u002Fdocs\u002Fprimitives\u002F19.frames\u002F7.rawsurfaceof.md","rawSurfaceOf",{"type":133,"value":134,"toc":327},"minimark",[135,139,147,168,183,186,191,228,232,285,289,313,317,323],[136,137,131],"h1",{"id":138},"rawsurfaceof",[140,141,142,143,146],"p",{},"The canvas like ",[10,144,145],{},"surfaceOf",", but always measured against the whole canvas, never a fitted box.",[148,149,154],"pre",{"className":150,"code":151,"language":152,"meta":153,"style":153},"language-ts shiki shiki-themes github-dark","rawSurfaceOf(params: GpuFragmentParams): {uv: Expr; viewport: Expr; aspect: Expr}\n","ts","",[10,155,156],{"__ignoreMap":153},[157,158,161,164],"span",{"class":159,"line":160},"line",1,[157,162,131],{"class":163},"svObZ",[157,165,167],{"class":166},"s95oV","(params: GpuFragmentParams): {uv: Expr; viewport: Expr; aspect: Expr}\n",[140,169,170,171,174,175,178,179,182],{},"Import ",[10,172,173],{},"frames"," from ",[10,176,177],{},"shaders\u002Fstd"," and use ",[10,180,181],{},"frames.rawSurfaceOf",".",[140,184,185],{},"Use it when a pattern should stay anchored to the canvas as the layer is resized.",[187,188,190],"h2",{"id":189},"parameters","Parameters",[192,193,194,210],"table",{},[195,196,197],"thead",{},[198,199,200,204,207],"tr",{},[201,202,203],"th",{},"Name",[201,205,206],{},"Type",[201,208,209],{},"Notes",[211,212,213],"tbody",{},[198,214,215,221,226],{},[216,217,218],"td",{},[10,219,220],{},"params",[216,222,223],{},[10,224,225],{},"GpuFragmentParams",[216,227],{},[187,229,231],{"id":230},"example","Example",[148,233,235],{"className":150,"code":234,"language":152,"meta":153,"style":153},"const {delta, dist} = centredFrame({center: p('center')})(params, rawSurfaceOf(params))\n",[10,236,237],{"__ignoreMap":153},[157,238,239,243,246,250,253,256,259,262,265,268,270,273,277,280,282],{"class":159,"line":160},[157,240,242],{"class":241},"snl16","const",[157,244,245],{"class":166}," {",[157,247,249],{"class":248},"sDLfK","delta",[157,251,252],{"class":166},", ",[157,254,255],{"class":248},"dist",[157,257,258],{"class":166},"} ",[157,260,261],{"class":241},"=",[157,263,264],{"class":163}," centredFrame",[157,266,267],{"class":166},"({center: ",[157,269,140],{"class":163},[157,271,272],{"class":166},"(",[157,274,276],{"class":275},"sU2Wk","'center'",[157,278,279],{"class":166},")})(params, ",[157,281,131],{"class":163},[157,283,284],{"class":166},"(params))\n",[187,286,288],{"id":287},"see-also","See also",[290,291,292],"ul",{},[293,294,295,301,302,305,306,309,310,182],"li",{},[296,297,299],"a",{"href":298},"\u002Fdocs\u002Fprimitives\u002Fframes\u002Fsurfaceof",[10,300,145],{}," — The canvas a generator paints on: its ",[10,303,304],{},"uv",", its ",[10,307,308],{},"viewport"," size in pixels and its ",[10,311,312],{},"aspect",[187,314,316],{"id":315},"used-by","Used by",[140,318,319],{},[296,320,322],{"href":321},"\u002Fdocs\u002Fcomponents\u002Fblob","Blob",[324,325,326],"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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}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":153,"searchDepth":328,"depth":328,"links":329},2,[330,331,332,333],{"id":189,"depth":328,"text":190},{"id":230,"depth":328,"text":231},{"id":287,"depth":328,"text":288},{"id":315,"depth":328,"text":316},"Frames & coordinates",false,"The canvas like `surfaceOf`, but always measured against the whole canvas, never a fitted box.",null,"md","space","Shapes, frames & warps","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fframes\u002Frawsurfaceof",{"title":131,"description":336},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fframes.ts#L55","docs\u002Fprimitives\u002F19.frames\u002F7.rawsurfaceof","lDLob2mLpAWJ7Dz5IBT-iCfAGd571JcdHUETGMZZxiA"]