[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"github-stars":3,"guide-nav":5,"doc-\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fguarded":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":220,"categorySlug":220,"categoryTitle":514,"curated":515,"description":141,"editUrl":516,"extension":517,"group":518,"groupTitle":519,"kind":520,"meta":521,"navigation":522,"path":523,"seo":524,"sourceUrl":525,"stem":526,"wordCount":516,"__hash__":527},"primitives\u002Fdocs\u002Fprimitives\u002F14.materials\u002F38.guarded.md","guarded",{"type":133,"value":134,"toc":508},"minimark",[135,138,142,215,230,240,245,341,345,409,421,425,446,450,504],[136,137,131],"h1",{"id":131},[139,140,141],"p",{},"Evaluates an expression only where a condition holds, and a cheap fallback everywhere else.",[143,144,149],"pre",{"className":145,"code":146,"language":147,"meta":148,"style":148},"language-ts shiki shiki-themes github-dark","guarded(\n  cond: Expr,\n  inner: Expr,\n  fallback: Expr,\n  hint: string = 'guarded',\n  deps: Expr[] = [],\n): Expr\n","ts","",[10,150,151,163,169,175,181,198,209],{"__ignoreMap":148},[152,153,156,159],"span",{"class":154,"line":155},"line",1,[152,157,131],{"class":158},"svObZ",[152,160,162],{"class":161},"s95oV","(\n",[152,164,166],{"class":154,"line":165},2,[152,167,168],{"class":161},"  cond: Expr,\n",[152,170,172],{"class":154,"line":171},3,[152,173,174],{"class":161},"  inner: Expr,\n",[152,176,178],{"class":154,"line":177},4,[152,179,180],{"class":161},"  fallback: Expr,\n",[152,182,184,187,191,195],{"class":154,"line":183},5,[152,185,186],{"class":161},"  hint: string ",[152,188,190],{"class":189},"snl16","=",[152,192,194],{"class":193},"sU2Wk"," 'guarded'",[152,196,197],{"class":161},",\n",[152,199,201,204,206],{"class":154,"line":200},6,[152,202,203],{"class":161},"  deps: Expr[] ",[152,205,190],{"class":189},[152,207,208],{"class":161}," [],\n",[152,210,212],{"class":154,"line":211},7,[152,213,214],{"class":161},"): Expr\n",[139,216,217,218,221,222,225,226,229],{},"Import ",[10,219,220],{},"materials"," from ",[10,223,224],{},"shaders\u002Fstd"," and use ",[10,227,228],{},"materials.guarded",".",[139,231,232,233,236,237,229],{},"Use it to skip a material's whole body for pixels outside the shape. Any value you build inside ",[10,234,235],{},"inner"," and also read after the guard must be listed in ",[10,238,239],{},"deps",[241,242,244],"h2",{"id":243},"parameters","Parameters",[246,247,248,264],"table",{},[249,250,251],"thead",{},[252,253,254,258,261],"tr",{},[255,256,257],"th",{},"Name",[255,259,260],{},"Type",[255,262,263],{},"Notes",[265,266,267,282,294,307,325],"tbody",{},[252,268,269,275,280],{},[270,271,272],"td",{},[10,273,274],{},"cond",[270,276,277],{},[10,278,279],{},"Expr",[270,281],{},[252,283,284,288,292],{},[270,285,286],{},[10,287,235],{},[270,289,290],{},[10,291,279],{},[270,293],{},[252,295,296,301,305],{},[270,297,298],{},[10,299,300],{},"fallback",[270,302,303],{},[10,304,279],{},[270,306],{},[252,308,309,314,319],{},[270,310,311],{},[10,312,313],{},"hint",[270,315,316],{},[10,317,318],{},"string",[270,320,321,322,229],{},"Optional. Default ",[10,323,324],{},"'guarded'",[252,326,327,331,336],{},[270,328,329],{},[10,330,239],{},[270,332,333],{},[10,334,335],{},"Expr[]",[270,337,321,338,229],{},[10,339,340],{},"[]",[241,342,344],{"id":343},"example","Example",[143,346,348],{"className":145,"code":347,"language":147,"meta":148,"style":148},"return guarded(insideShape(field.sdf, field.pxH), vec4(rgb, silhouette(field, u.edgeSoftness)), vec4(0, 0, 0, 0), 'plastic')\n",[10,349,350],{"__ignoreMap":148},[152,351,352,355,358,361,364,367,370,373,376,379,381,383,387,390,392,394,396,398,400,403,406],{"class":154,"line":155},[152,353,354],{"class":189},"return",[152,356,357],{"class":158}," guarded",[152,359,360],{"class":161},"(",[152,362,363],{"class":158},"insideShape",[152,365,366],{"class":161},"(field.sdf, field.pxH), ",[152,368,369],{"class":158},"vec4",[152,371,372],{"class":161},"(rgb, ",[152,374,375],{"class":158},"silhouette",[152,377,378],{"class":161},"(field, u.edgeSoftness)), ",[152,380,369],{"class":158},[152,382,360],{"class":161},[152,384,386],{"class":385},"sDLfK","0",[152,388,389],{"class":161},", ",[152,391,386],{"class":385},[152,393,389],{"class":161},[152,395,386],{"class":385},[152,397,389],{"class":161},[152,399,386],{"class":385},[152,401,402],{"class":161},"), ",[152,404,405],{"class":193},"'plastic'",[152,407,408],{"class":161},")\n",[410,411,412],"blockquote",{},[139,413,414,418,419,229],{},[415,416,417],"strong",{},"Tip."," Values first made inside the guard are not visible after it. Put shared locals in ",[10,420,239],{},[241,422,424],{"id":423},"see-also","See also",[426,427,428,438],"ul",{},[429,430,431,437],"li",{},[432,433,435],"a",{"href":434},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Finsideshape",[10,436,363],{}," — True inside the shape and up to two pixels outside it.",[429,439,440,445],{},[432,441,443],{"href":442},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fsilhouette",[10,444,375],{}," — The shape's coverage at this pixel: 1 inside, 0 outside, soft across the edge.",[241,447,449],{"id":448},"used-by","Used by",[139,451,452,389,456,389,460,389,464,389,468,389,472,389,476,389,480,389,484,389,488,389,492,389,496,389,500],{},[432,453,455],{"href":454},"\u002Fdocs\u002Fcomponents\u002Fbrushedmetal","BrushedMetal",[432,457,459],{"href":458},"\u002Fdocs\u002Fcomponents\u002Fcarbonfiber","CarbonFiber",[432,461,463],{"href":462},"\u002Fdocs\u002Fcomponents\u002Fchrome","Chrome",[432,465,467],{"href":466},"\u002Fdocs\u002Fcomponents\u002Ffrost","Frost",[432,469,471],{"href":470},"\u002Fdocs\u002Fcomponents\u002Fgoo","Goo",[432,473,475],{"href":474},"\u002Fdocs\u002Fcomponents\u002Fhologram","Hologram",[432,477,479],{"href":478},"\u002Fdocs\u002Fcomponents\u002Fholographic","Holographic",[432,481,483],{"href":482},"\u002Fdocs\u002Fcomponents\u002Firradiance","Irradiance",[432,485,487],{"href":486},"\u002Fdocs\u002Fcomponents\u002Fliquidmetal","LiquidMetal",[432,489,491],{"href":490},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[432,493,495],{"href":494},"\u002Fdocs\u002Fcomponents\u002Fobsidian","Obsidian",[432,497,499],{"href":498},"\u002Fdocs\u002Fcomponents\u002Fplastic","Plastic",[432,501,503],{"href":502},"\u002Fdocs\u002Fcomponents\u002Fwater","Water",[505,506,507],"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 pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":148,"searchDepth":165,"depth":165,"links":509},[510,511,512,513],{"id":243,"depth":165,"text":244},{"id":343,"depth":165,"text":344},{"id":423,"depth":165,"text":424},{"id":448,"depth":165,"text":449},"Materials & surfaces",false,null,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fguarded",{"title":131,"description":141},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fmaterials.ts#L85","docs\u002Fprimitives\u002F14.materials\u002F38.guarded","ftsEybKmyuh9i3CebhpnaL3dLyO6x9fvrDJZ35cBIHo"]