[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fregistershader":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":413,"categorySlug":413,"categoryTitle":414,"curated":415,"description":416,"editUrl":417,"extension":418,"group":413,"groupTitle":419,"kind":420,"meta":421,"navigation":318,"path":422,"seo":423,"sourceUrl":424,"stem":425,"wordCount":417,"__hash__":426},"primitives\u002Fdocs\u002Fprimitives\u002F1.define\u002F3.registershader.md","registerShader",{"type":133,"value":134,"toc":408},"minimark",[135,139,151,208,217,236,241,276,280,361,365,404],[136,137,131],"h1",{"id":138},"registershader",[140,141,142,143,146,147,150],"p",{},"Make a user-defined shader findable by its ",[10,144,145],{},"name",", so preset JSON can reference it as ",[10,148,149],{},"type: 'Halo'",".",[152,153,158],"pre",{"className":154,"code":155,"language":156,"meta":157,"style":157},"language-ts shiki shiki-themes github-dark","registerShader\u003CT extends GpuShaderDefinition\u003Cany>>(definition: T): T\n","ts","",[10,159,160],{"__ignoreMap":157},[161,162,165,169,173,177,180,183,187,190,194,197,200,203,205],"span",{"class":163,"line":164},"line",1,[161,166,168],{"class":167},"s95oV","registerShader\u003C",[161,170,172],{"class":171},"svObZ","T",[161,174,176],{"class":175},"snl16"," extends",[161,178,179],{"class":171}," GpuShaderDefinition",[161,181,182],{"class":167},"\u003C",[161,184,186],{"class":185},"sDLfK","any",[161,188,189],{"class":167},">>(",[161,191,193],{"class":192},"s9osk","definition",[161,195,196],{"class":175},":",[161,198,199],{"class":171}," T",[161,201,202],{"class":167},")",[161,204,196],{"class":175},[161,206,207],{"class":171}," T\n",[140,209,210,211,213,214,150],{},"Import ",[10,212,131],{}," from ",[10,215,216],{},"shaders\u002Fstd",[140,218,219,220,223,224,227,228,231,232,235],{},"Returns the definition, so it can wrap ",[10,221,222],{},"defineShader"," inline. Registering the same object again does nothing. A different definition under a taken name replaces it (live editing, hot reload) and notifies ",[10,225,226],{},"onShaderRegistered"," listeners. ",[10,229,230],{},"\u003CCustomShader>"," calls this for you on mount; ",[10,233,234],{},"createShader(canvas, preset, {components: [Halo]})"," is the other way to make a name resolvable without registering globally.",[237,238,240],"h2",{"id":239},"parameters","Parameters",[242,243,244,260],"table",{},[245,246,247],"thead",{},[248,249,250,254,257],"tr",{},[251,252,253],"th",{},"Name",[251,255,256],{},"Type",[251,258,259],{},"Notes",[261,262,263],"tbody",{},[248,264,265,270,274],{},[266,267,268],"td",{},[10,269,193],{},[266,271,272],{},[10,273,172],{},[266,275],{},[237,277,279],{"id":278},"example","Example",[152,281,283],{"className":154,"code":282,"language":156,"meta":157,"style":157},"import {createShader} from 'shaders\u002Fjs'\nimport {Halo} from '.\u002Fhalo'\n\nregisterShader(Halo)\nconst shader = await createShader(canvas, {components: [{type: 'Halo', props: {bands: 6}}]})\n",[10,284,285,300,313,320,328],{"__ignoreMap":157},[161,286,287,290,293,296],{"class":163,"line":164},[161,288,289],{"class":175},"import",[161,291,292],{"class":167}," {createShader} ",[161,294,295],{"class":175},"from",[161,297,299],{"class":298},"sU2Wk"," 'shaders\u002Fjs'\n",[161,301,303,305,308,310],{"class":163,"line":302},2,[161,304,289],{"class":175},[161,306,307],{"class":167}," {Halo} ",[161,309,295],{"class":175},[161,311,312],{"class":298}," '.\u002Fhalo'\n",[161,314,316],{"class":163,"line":315},3,[161,317,319],{"emptyLinePlaceholder":318},true,"\n",[161,321,323,325],{"class":163,"line":322},4,[161,324,131],{"class":171},[161,326,327],{"class":167},"(Halo)\n",[161,329,331,334,337,340,343,346,349,352,355,358],{"class":163,"line":330},5,[161,332,333],{"class":175},"const",[161,335,336],{"class":185}," shader",[161,338,339],{"class":175}," =",[161,341,342],{"class":175}," await",[161,344,345],{"class":171}," createShader",[161,347,348],{"class":167},"(canvas, {components: [{type: ",[161,350,351],{"class":298},"'Halo'",[161,353,354],{"class":167},", props: {bands: ",[161,356,357],{"class":185},"6",[161,359,360],{"class":167},"}}]})\n",[237,362,364],{"id":363},"see-also","See also",[366,367,368,378,387,396],"ul",{},[369,370,371,377],"li",{},[372,373,375],"a",{"href":374},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fdefineshader",[10,376,222],{}," — Define a shader component from a plain object: its props, and one field that says what it draws.",[369,379,380,386],{},[372,381,383],{"href":382},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Funregistershader",[10,384,385],{},"unregisterShader"," — Forget a user-defined shader by name.",[369,388,389,395],{},[372,390,392],{"href":391},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fgetregisteredshader",[10,393,394],{},"getRegisteredShader"," — Look up a user-defined shader by name.",[369,397,398,403],{},[372,399,401],{"href":400},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fonshaderregistered",[10,402,226],{}," — Be told when a user-defined shader is registered, replaced or removed.",[405,406,407],"style",{},"html pre.shiki code .s95oV, html code.shiki .s95oV{--shiki-default:#E1E4E8}html pre.shiki code .svObZ, html code.shiki .svObZ{--shiki-default:#B392F0}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 .s9osk, html code.shiki .s9osk{--shiki-default:#FFAB70}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}",{"title":157,"searchDepth":302,"depth":302,"links":409},[410,411,412],{"id":239,"depth":302,"text":240},{"id":278,"depth":302,"text":279},{"id":363,"depth":302,"text":364},"define","defineShader & wgsl",false,"Make a user-defined shader findable by its `name`, so preset JSON can reference it as `type: 'Halo'`.",null,"md","Defining a shader","function",{},"\u002Fdocs\u002Fprimitives\u002Fdefine\u002Fregistershader",{"title":131,"description":416},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002FcustomShaders.ts#L37","docs\u002Fprimitives\u002F1.define\u002F3.registershader","kVxzUsrRyz_9bIcud43F-_OKgsUOL-V9GWRdK-XUAXI"]