[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fwgsl":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":504,"categorySlug":504,"categoryTitle":505,"curated":506,"description":507,"editUrl":9,"extension":508,"group":504,"groupTitle":509,"kind":510,"meta":511,"navigation":512,"path":513,"seo":514,"sourceUrl":515,"stem":516,"wordCount":9,"__hash__":517},"primitives\u002Fdocs\u002Fprimitives\u002F1.define\u002F2.wgsl.md","wgsl",{"type":149,"value":150,"toc":499},"minimark",[151,154,162,206,216,281,296,301,338,342,376,413,442,446,495],[152,153,147],"h1",{"id":147},[155,156,157,158,161],"p",{},"Write the per-pixel math by hand, as one WGSL function body that returns a ",[8,159,160],{},"vec4f"," color.",[163,164,169],"pre",{"className":165,"code":166,"language":167,"meta":168,"style":168},"language-ts shiki shiki-themes github-dark","wgsl(spec: WgslSpec): WgslBody\nwgsl(body: string): WgslBody\nwgsl(strings: TemplateStringsArray, ...values: unknown[]): WgslBody\n","ts","",[8,170,171,183,191],{"__ignoreMap":168},[172,173,176,179],"span",{"class":174,"line":175},"line",1,[172,177,147],{"class":178},"svObZ",[172,180,182],{"class":181},"s95oV","(spec: WgslSpec): WgslBody\n",[172,184,186,188],{"class":174,"line":185},2,[172,187,147],{"class":178},[172,189,190],{"class":181},"(body: string): WgslBody\n",[172,192,194,196,199,203],{"class":174,"line":193},3,[172,195,147],{"class":178},[172,197,198],{"class":181},"(strings: TemplateStringsArray, ",[172,200,202],{"class":201},"snl16","...",[172,204,205],{"class":181},"values: unknown[]): WgslBody\n",[155,207,208,209,211,212,215],{},"Import ",[8,210,147],{}," from ",[8,213,214],{},"shaders\u002Fstd",".",[155,217,218,219,222,223,226,227,229,230,233,234,237,238,241,242,245,246,249,250,253,254,257,258,261,262,264,265,268,269,272,273,276,277,280],{},"Put it in ",[8,220,221],{},"paint:"," for a generator or ",[8,224,225],{},"effect:"," for a filter. Every name the body uses is bound for you. The definition's props come by name: colors as ",[8,228,160],{}," in linear RGB with alpha, positions as ",[8,231,232],{},"vec2f"," in uv, numbers and booleans as ",[8,235,236],{},"f32",", select props as their numeric value. The context comes as ",[8,239,240],{},"uv"," (0–1 across the canvas, y down), ",[8,243,244],{},"time"," (seconds; the layer's own clock when ",[8,247,248],{},"animatedTime"," is declared, paused at speed 0), ",[8,251,252],{},"aspect"," (width \u002F height), ",[8,255,256],{},"viewport"," (the frame size in device pixels) and ",[8,259,260],{},"pointer"," (the mouse in uv). In an ",[8,263,225],{}," body ",[8,266,267],{},"child"," is the color of the layer inside at this pixel. Sample ",[8,270,271],{},"childTexture"," with ",[8,274,275],{},"childSampler"," instead when you need neighbouring pixels (a blur, a displacement): that gives the filter its own render pass and hands you premultiplied color, which is unpremultiplied for you on the way out. Template values (",[8,278,279],{},"${OCTAVES}",") are pasted in as text, so a constant can be a loop bound.",[155,282,283,284,287,288,291,292,295],{},"Use the ",[8,285,286],{},"{body, inputs, alpha}"," form to bind extra names (",[8,289,290],{},"inputs: {t: ctx.time, k: 4}",") or to say a gather body already returns straight alpha (",[8,293,294],{},"alpha: 'straight'",").",[297,298,300],"h2",{"id":299},"parameters","Parameters",[302,303,304,320],"table",{},[305,306,307],"thead",{},[308,309,310,314,317],"tr",{},[311,312,313],"th",{},"Name",[311,315,316],{},"Type",[311,318,319],{},"Notes",[321,322,323],"tbody",{},[308,324,325,331,336],{},[326,327,328],"td",{},[8,329,330],{},"spec",[326,332,333],{},[8,334,335],{},"WgslSpec",[326,337],{},[297,339,341],{"id":340},"examples","Examples",[163,343,345],{"className":165,"code":344,"language":167,"meta":168,"style":168},"paint: wgsl`\n  let d = length((uv - center) * vec2f(aspect, 1.0)) \u002F radius;\n  return vec4f(mix(outer.rgb, inner.rgb, 1.0 - smoothstep(0.0, 1.0, d)), 1.0);\n`\n",[8,346,347,361,366,371],{"__ignoreMap":168},[172,348,349,352,355,357],{"class":174,"line":175},[172,350,351],{"class":178},"paint",[172,353,354],{"class":181},": ",[172,356,147],{"class":178},[172,358,360],{"class":359},"sU2Wk","`\n",[172,362,363],{"class":174,"line":185},[172,364,365],{"class":359},"  let d = length((uv - center) * vec2f(aspect, 1.0)) \u002F radius;\n",[172,367,368],{"class":174,"line":193},[172,369,370],{"class":359},"  return vec4f(mix(outer.rgb, inner.rgb, 1.0 - smoothstep(0.0, 1.0, d)), 1.0);\n",[172,372,374],{"class":174,"line":373},4,[172,375,360],{"class":359},[163,377,379],{"className":165,"code":378,"language":167,"meta":168,"style":168},"\u002F\u002F A gather filter: the layer inside, sampled at a rippled coordinate.\neffect: wgsl`\n  let wave = sin(length(uv - center) * frequency - time * 4.0) * amplitude;\n  return textureSample(childTexture, childSampler, uv + wave);\n`\n",[8,380,381,387,398,403,408],{"__ignoreMap":168},[172,382,383],{"class":174,"line":175},[172,384,386],{"class":385},"sAwPA","\u002F\u002F A gather filter: the layer inside, sampled at a rippled coordinate.\n",[172,388,389,392,394,396],{"class":174,"line":185},[172,390,391],{"class":178},"effect",[172,393,354],{"class":181},[172,395,147],{"class":178},[172,397,360],{"class":359},[172,399,400],{"class":174,"line":193},[172,401,402],{"class":359},"  let wave = sin(length(uv - center) * frequency - time * 4.0) * amplitude;\n",[172,404,405],{"class":174,"line":373},[172,406,407],{"class":359},"  return textureSample(childTexture, childSampler, uv + wave);\n",[172,409,411],{"class":174,"line":410},5,[172,412,360],{"class":359},[414,415,416],"blockquote",{},[155,417,418,422,423,425,426,425,428,425,430,425,432,425,434,425,436,438,439,441],{},[419,420,421],"strong",{},"Tip."," The names ",[8,424,240],{},", ",[8,427,244],{},[8,429,252],{},[8,431,256],{},[8,433,260],{},[8,435,267],{},[8,437,271],{}," and ",[8,440,275],{}," belong to the body; a prop spelled the same is not bound, so rename the prop.",[297,443,445],{"id":444},"see-also","See also",[447,448,449,460,487],"ul",{},[450,451,452,459],"li",{},[453,454,456],"a",{"href":455},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fdefineshader",[8,457,458],{},"defineShader"," — Define a shader component from a plain object: its props, and one field that says what it draws.",[450,461,462,468,469,425,472,425,475,425,478,425,481,425,484,215],{},[453,463,465],{"href":464},"\u002Fdocs\u002Fprimitives\u002Finvoke\u002Fctx",[8,466,467],{},"ctx"," — The context values as tokens: ",[8,470,471],{},"ctx.uv",[8,473,474],{},"ctx.time",[8,476,477],{},"ctx.aspect",[8,479,480],{},"ctx.pointer",[8,482,483],{},"ctx.viewportSize",[8,485,486],{},"ctx.logicalViewportSize",[450,488,489,494],{},[453,490,492],{"href":491},"\u002Fdocs\u002Fprimitives\u002Fvalues\u002Fp",[8,493,155],{}," — Reference one of the definition's props by name, wherever a word asks for a value.",[496,497,498],"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 .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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}html pre.shiki code .sAwPA, html code.shiki .sAwPA{--shiki-default:#6A737D}",{"title":168,"searchDepth":185,"depth":185,"links":500},[501,502,503],{"id":299,"depth":185,"text":300},{"id":340,"depth":185,"text":341},{"id":444,"depth":185,"text":445},"define","defineShader & wgsl",false,"Write the per-pixel math by hand, as one WGSL function body that returns a `vec4f` color.","md","Defining a shader","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fwgsl",{"title":147,"description":507},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fwgsl.ts#L159","docs\u002Fprimitives\u002F1.define\u002F2.wgsl","wBCmtxxE5xdod0Ikgv0msvVmd41ntPwrW6hWB2USFaI"]