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