[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Finvoke\u002Fpaintframe":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":472,"categorySlug":472,"categoryTitle":473,"curated":474,"description":475,"editUrl":476,"extension":477,"group":478,"groupTitle":479,"kind":480,"meta":481,"navigation":482,"path":483,"seo":484,"sourceUrl":485,"stem":486,"wordCount":476,"__hash__":487},"primitives\u002Fdocs\u002Fprimitives\u002F4.invoke\u002F8.paintframe.md","paintFrame",{"type":133,"value":134,"toc":467},"minimark",[135,139,147,168,178,189,194,231,235,415,419,463],[136,137,131],"h1",{"id":138},"paintframe",[140,141,142,143,146],"p",{},"The coordinate and frame size a hand-written ",[10,144,145],{},"paint:"," builder should draw in.",[148,149,154],"pre",{"className":150,"code":151,"language":152,"meta":153,"style":153},"language-ts shiki shiki-themes github-dark","paintFrame(params: GpuFragmentParams): {uv: Expr; viewport: 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}\n",[140,169,170,171,173,174,177],{},"Import ",[10,172,131],{}," from ",[10,175,176],{},"shaders\u002Fstd",".",[140,179,180,181,184,185,188],{},"Returns ",[10,182,183],{},"uv"," and ",[10,186,187],{},"viewport"," as GPU values. Inside a distortion the uv is the distorted one, and inside a sized box the viewport is the box, so a generator built on these behaves like the library's own.",[190,191,193],"h2",{"id":192},"parameters","Parameters",[195,196,197,213],"table",{},[198,199,200],"thead",{},[201,202,203,207,210],"tr",{},[204,205,206],"th",{},"Name",[204,208,209],{},"Type",[204,211,212],{},"Notes",[214,215,216],"tbody",{},[201,217,218,224,229],{},[219,220,221],"td",{},[10,222,223],{},"params",[219,225,226],{},[10,227,228],{},"GpuFragmentParams",[219,230],{},[190,232,234],{"id":233},"example","Example",[148,236,238],{"className":150,"code":237,"language":152,"meta":153,"style":153},"paint: (params) => {\n  const {uv} = paintFrame(params)\n  const center = uniformOf(p('center'), params)\n  const d = length(sub(uv, vec2(center.member('x'), sub(1, center.member('y')))))\n  return vec4(splat3(smoothstep(0, 0.5, d)), 1)\n}\n",[10,239,240,261,285,313,371,409],{"__ignoreMap":153},[157,241,242,245,248,251,254,258],{"class":159,"line":160},[157,243,244],{"class":163},"paint",[157,246,247],{"class":166},": (",[157,249,223],{"class":250},"s9osk",[157,252,253],{"class":166},") ",[157,255,257],{"class":256},"snl16","=>",[157,259,260],{"class":166}," {\n",[157,262,264,267,270,273,276,279,282],{"class":159,"line":263},2,[157,265,266],{"class":256},"  const",[157,268,269],{"class":166}," {",[157,271,183],{"class":272},"sDLfK",[157,274,275],{"class":166},"} ",[157,277,278],{"class":256},"=",[157,280,281],{"class":163}," paintFrame",[157,283,284],{"class":166},"(params)\n",[157,286,288,290,293,296,299,302,304,306,310],{"class":159,"line":287},3,[157,289,266],{"class":256},[157,291,292],{"class":272}," center",[157,294,295],{"class":256}," =",[157,297,298],{"class":163}," uniformOf",[157,300,301],{"class":166},"(",[157,303,140],{"class":163},[157,305,301],{"class":166},[157,307,309],{"class":308},"sU2Wk","'center'",[157,311,312],{"class":166},"), params)\n",[157,314,316,318,321,323,326,328,331,334,337,340,343,345,348,351,353,355,358,361,363,365,368],{"class":159,"line":315},4,[157,317,266],{"class":256},[157,319,320],{"class":272}," d",[157,322,295],{"class":256},[157,324,325],{"class":163}," length",[157,327,301],{"class":166},[157,329,330],{"class":163},"sub",[157,332,333],{"class":166},"(uv, ",[157,335,336],{"class":163},"vec2",[157,338,339],{"class":166},"(center.",[157,341,342],{"class":163},"member",[157,344,301],{"class":166},[157,346,347],{"class":308},"'x'",[157,349,350],{"class":166},"), ",[157,352,330],{"class":163},[157,354,301],{"class":166},[157,356,357],{"class":272},"1",[157,359,360],{"class":166},", center.",[157,362,342],{"class":163},[157,364,301],{"class":166},[157,366,367],{"class":308},"'y'",[157,369,370],{"class":166},")))))\n",[157,372,374,377,380,382,385,387,390,392,395,398,401,404,406],{"class":159,"line":373},5,[157,375,376],{"class":256},"  return",[157,378,379],{"class":163}," vec4",[157,381,301],{"class":166},[157,383,384],{"class":163},"splat3",[157,386,301],{"class":166},[157,388,389],{"class":163},"smoothstep",[157,391,301],{"class":166},[157,393,394],{"class":272},"0",[157,396,397],{"class":166},", ",[157,399,400],{"class":272},"0.5",[157,402,403],{"class":166},", d)), ",[157,405,357],{"class":272},[157,407,408],{"class":166},")\n",[157,410,412],{"class":159,"line":411},6,[157,413,414],{"class":166},"}\n",[190,416,418],{"id":417},"see-also","See also",[420,421,422,451],"ul",{},[423,424,425,432,433,397,436,397,439,397,442,397,445,397,448,177],"li",{},[426,427,429],"a",{"href":428},"\u002Fdocs\u002Fprimitives\u002Finvoke\u002Fctx",[10,430,431],{},"ctx"," — The context values as tokens: ",[10,434,435],{},"ctx.uv",[10,437,438],{},"ctx.time",[10,440,441],{},"ctx.aspect",[10,443,444],{},"ctx.pointer",[10,446,447],{},"ctx.viewportSize",[10,449,450],{},"ctx.logicalViewportSize",[423,452,453,459,460,177],{},[426,454,456],{"href":455},"\u002Fdocs\u002Fprimitives\u002Finvoke\u002Funiformof",[10,457,458],{},"uniformOf"," — The live GPU value of a prop, for a hand-written builder: ",[10,461,462],{},"uniformOf(p('radius'), params)",[464,465,466],"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}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":153,"searchDepth":263,"depth":263,"links":468},[469,470,471],{"id":192,"depth":263,"text":193},{"id":233,"depth":263,"text":234},{"id":417,"depth":263,"text":418},"invoke","Context & invocation",false,"The coordinate and frame size a hand-written `paint:` builder should draw in.",null,"md","define","Defining a shader","function",{},true,"\u002Fdocs\u002Fprimitives\u002Finvoke\u002Fpaintframe",{"title":131,"description":475},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Finvoke.ts#L87","docs\u002Fprimitives\u002F4.invoke\u002F8.paintframe","fTMv_gPb3b4H1TFuxn0ylVoGtSGyOyWU8pvycpA0chg"]