[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fgeometricnormal":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":226,"categorySlug":226,"categoryTitle":458,"curated":459,"description":158,"editUrl":9,"extension":460,"group":461,"groupTitle":462,"kind":463,"meta":464,"navigation":465,"path":466,"seo":467,"sourceUrl":468,"stem":469,"wordCount":9,"__hash__":470},"primitives\u002Fdocs\u002Fprimitives\u002F14.materials\u002F3.geometricnormal.md","geometricNormal",{"type":149,"value":150,"toc":452},"minimark",[151,155,159,221,236,259,264,329,333,356,374,378,417,421,448],[152,153,147],"h1",{"id":154},"geometricnormal",[156,157,158],"p",{},"The surface normal of the shape, whichever kind of shape is active.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","geometricNormal(\n  frame: SurfaceFrame,\n  field: SurfaceField,\n  opts: {bevelWidth: Expr; bevelShape: Expr; sharpness?: number; eps?: number; hint?: string},\n): Expr\n","ts","",[8,167,168,180,186,192,215],{"__ignoreMap":165},[169,170,173,176],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(\n",[169,181,183],{"class":171,"line":182},2,[169,184,185],{"class":178},"  frame: SurfaceFrame,\n",[169,187,189],{"class":171,"line":188},3,[169,190,191],{"class":178},"  field: SurfaceField,\n",[169,193,195,198,202,205,207,210,212],{"class":171,"line":194},4,[169,196,197],{"class":178},"  opts: {bevelWidth: Expr; bevelShape: Expr; sharpness",[169,199,201],{"class":200},"snl16","?:",[169,203,204],{"class":178}," number; eps",[169,206,201],{"class":200},[169,208,209],{"class":178}," number; hint",[169,211,201],{"class":200},[169,213,214],{"class":178}," string},\n",[169,216,218],{"class":171,"line":217},5,[169,219,220],{"class":178},"): Expr\n",[156,222,223,224,227,228,231,232,235],{},"Import ",[8,225,226],{},"materials"," from ",[8,229,230],{},"shaders\u002Fstd"," and use ",[8,233,234],{},"materials.geometricNormal",".",[156,237,238,239,242,243,246,247,250,251,254,255,258],{},"A 3D shape takes its normal from the marched depth. A flat shape takes a normal that tilts away from the face near the edge, over ",[8,240,241],{},"bevelWidth"," (in the units of ",[8,244,245],{},"field.sdf",") with the profile ",[8,248,249],{},"bevelShape"," (0 round, 1 machined). ",[8,252,253],{},"sharpness"," clamps the 3D slope (default 5, lower is calmer). ",[8,256,257],{},"eps"," must match the stencil step (default 0.01). Needs a stencil with neighbour taps.",[260,261,263],"h2",{"id":262},"parameters","Parameters",[265,266,267,283],"table",{},[268,269,270],"thead",{},[271,272,273,277,280],"tr",{},[274,275,276],"th",{},"Name",[274,278,279],{},"Type",[274,281,282],{},"Notes",[284,285,286,301,315],"tbody",{},[271,287,288,294,299],{},[289,290,291],"td",{},[8,292,293],{},"frame",[289,295,296],{},[8,297,298],{},"SurfaceFrame",[289,300],{},[271,302,303,308,313],{},[289,304,305],{},[8,306,307],{},"field",[289,309,310],{},[8,311,312],{},"SurfaceField",[289,314],{},[271,316,317,322,327],{},[289,318,319],{},[8,320,321],{},"opts",[289,323,324],{},[8,325,326],{},"{bevelWidth: Expr; bevelShape: Expr; sharpness?: number; eps?: number; hint?: string}",[289,328],{},[260,330,332],{"id":331},"example","Example",[160,334,336],{"className":162,"code":335,"language":164,"meta":165,"style":165},"const n = geometricNormal(frame, field, {bevelWidth: u.bevelWidth, bevelShape: u.bevelShape})\n",[8,337,338],{"__ignoreMap":165},[169,339,340,343,347,350,353],{"class":171,"line":172},[169,341,342],{"class":200},"const",[169,344,346],{"class":345},"sDLfK"," n",[169,348,349],{"class":200}," =",[169,351,352],{"class":175}," geometricNormal",[169,354,355],{"class":178},"(frame, field, {bevelWidth: u.bevelWidth, bevelShape: u.bevelShape})\n",[357,358,359],"blockquote",{},[156,360,361,365,366,369,370,373],{},[362,363,364],"strong",{},"Tip."," Add relief with ",[8,367,368],{},"nudgeNormal"," or ",[8,371,372],{},"tiltNormal"," after this, never before.",[260,375,377],{"id":376},"see-also","See also",[379,380,381,392,400,408],"ul",{},[382,383,384,391],"li",{},[385,386,388],"a",{"href":387},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fmarchednormal",[8,389,390],{},"marchedNormal"," — The surface normal of a 3D shape, from the marched depth.",[382,393,394,399],{},[385,395,397],{"href":396},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fnudgenormal",[8,398,368],{}," — Tilts a normal by a slope in x and y, turning a height field into relief.",[382,401,402,407],{},[385,403,405],{"href":404},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Ftiltnormal",[8,406,372],{}," — Tilts a normal along and across a direction, for brushed or woven relief.",[382,409,410,416],{},[385,411,413],{"href":412},"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Ffieldslope",[8,414,415],{},"fieldSlope"," — The direction the shape's distance grows in: a 2D vector pointing outward at this pixel.",[260,418,420],{"id":419},"used-by","Used by",[156,422,423,427,428,427,432,427,436,427,440,427,444],{},[385,424,426],{"href":425},"\u002Fdocs\u002Fcomponents\u002Fbrushedmetal","BrushedMetal",", ",[385,429,431],{"href":430},"\u002Fdocs\u002Fcomponents\u002Fcarbonfiber","CarbonFiber",[385,433,435],{"href":434},"\u002Fdocs\u002Fcomponents\u002Firradiance","Irradiance",[385,437,439],{"href":438},"\u002Fdocs\u002Fcomponents\u002Fliquidmetal","LiquidMetal",[385,441,443],{"href":442},"\u002Fdocs\u002Fcomponents\u002Fnebula","Nebula",[385,445,447],{"href":446},"\u002Fdocs\u002Fcomponents\u002Fobsidian","Obsidian",[449,450,451],"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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}",{"title":165,"searchDepth":182,"depth":182,"links":453},[454,455,456,457],{"id":262,"depth":182,"text":263},{"id":331,"depth":182,"text":332},{"id":376,"depth":182,"text":377},{"id":419,"depth":182,"text":420},"Materials & surfaces",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fmaterials\u002Fgeometricnormal",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fmaterials.ts#L365","docs\u002Fprimitives\u002F14.materials\u002F3.geometricnormal","ge3f71Ic_4_fQCt_1ICfaEYuD7D-7L4MM2qRNp1gSjc"]