[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fnoise\u002Fnoiserelief":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":210,"categorySlug":210,"categoryTitle":478,"curated":479,"description":158,"editUrl":9,"extension":480,"group":481,"groupTitle":482,"kind":483,"meta":484,"navigation":485,"path":486,"seo":487,"sourceUrl":488,"stem":489,"wordCount":9,"__hash__":490},"primitives\u002Fdocs\u002Fprimitives\u002F12.noise\u002F31.noiserelief.md","noiseRelief",{"type":149,"value":150,"toc":472},"minimark",[151,155,159,205,220,255,260,296,300,412,426,430,454,458,468],[152,153,147],"h1",{"id":154},"noiserelief",[156,157,158],"p",{},"Embosses the layer inside with a textured surface: the child is slightly distorted, then lit by a height field so it reads as carved stone or woven cloth.",[160,161,166],"pre",{"className":162,"code":163,"language":164,"meta":165,"style":165},"language-ts shiki shiki-themes github-dark","noiseRelief(basis: ReliefBasis): (params: GpuFragmentParams) => Expr\n","ts","",[8,167,168],{"__ignoreMap":165},[169,170,173,176,180,184,187,191,193,196,199,202],"span",{"class":171,"line":172},"line",1,[169,174,147],{"class":175},"svObZ",[169,177,179],{"class":178},"s95oV","(basis: ReliefBasis)",[169,181,183],{"class":182},"snl16",":",[169,185,186],{"class":178}," (",[169,188,190],{"class":189},"s9osk","params",[169,192,183],{"class":182},[169,194,195],{"class":175}," GpuFragmentParams",[169,197,198],{"class":178},") ",[169,200,201],{"class":182},"=>",[169,203,204],{"class":178}," Expr\n",[156,206,207,208,211,212,215,216,219],{},"Import ",[8,209,210],{},"noise"," from ",[8,213,214],{},"shaders\u002Fstd"," and use ",[8,217,218],{},"noise.noiseRelief",".",[156,221,222,223,226,227,230,231,234,235,234,238,234,241,226,244,247,248,251,252,219],{},"A filter, not a paint. Set it as the definition's fragment with ",[8,224,225],{},"requiresRTT"," and ",[8,228,229],{},"requiresChild",", and give the definition props named ",[8,232,233],{},"intensity",", ",[8,236,237],{},"scale",[8,239,240],{},"contrast",[8,242,243],{},"distortion",[8,245,246],{},"seed",". ",[8,249,250],{},"basis"," is an entry of ",[8,253,254],{},"reliefBases",[256,257,259],"h2",{"id":258},"parameters","Parameters",[261,262,263,279],"table",{},[264,265,266],"thead",{},[267,268,269,273,276],"tr",{},[270,271,272],"th",{},"Name",[270,274,275],{},"Type",[270,277,278],{},"Notes",[280,281,282],"tbody",{},[267,283,284,289,294],{},[285,286,287],"td",{},[8,288,250],{},[285,290,291],{},[8,292,293],{},"ReliefBasis",[285,295],{},[256,297,299],{"id":298},"example","Example",[160,301,303],{"className":162,"code":302,"language":164,"meta":165,"style":165},"export const Stone = defineShader({\n  name: 'Stone',\n  requiresRTT: true,\n  requiresChild: true,\n  props: {intensity: {default: 0.5}, scale: {default: 1}, contrast: {default: 0}, distortion: {default: 0.15}, seed: {default: 0}},\n  gpu: {fragment: noiseRelief(reliefBases.stone)},\n})\n",[8,304,305,326,339,350,360,395,406],{"__ignoreMap":165},[169,306,307,310,313,317,320,323],{"class":171,"line":172},[169,308,309],{"class":182},"export",[169,311,312],{"class":182}," const",[169,314,316],{"class":315},"sDLfK"," Stone",[169,318,319],{"class":182}," =",[169,321,322],{"class":175}," defineShader",[169,324,325],{"class":178},"({\n",[169,327,329,332,336],{"class":171,"line":328},2,[169,330,331],{"class":178},"  name: ",[169,333,335],{"class":334},"sU2Wk","'Stone'",[169,337,338],{"class":178},",\n",[169,340,342,345,348],{"class":171,"line":341},3,[169,343,344],{"class":178},"  requiresRTT: ",[169,346,347],{"class":315},"true",[169,349,338],{"class":178},[169,351,353,356,358],{"class":171,"line":352},4,[169,354,355],{"class":178},"  requiresChild: ",[169,357,347],{"class":315},[169,359,338],{"class":178},[169,361,363,366,369,372,375,378,381,384,387,390,392],{"class":171,"line":362},5,[169,364,365],{"class":178},"  props: {intensity: {default: ",[169,367,368],{"class":315},"0.5",[169,370,371],{"class":178},"}, scale: {default: ",[169,373,374],{"class":315},"1",[169,376,377],{"class":178},"}, contrast: {default: ",[169,379,380],{"class":315},"0",[169,382,383],{"class":178},"}, distortion: {default: ",[169,385,386],{"class":315},"0.15",[169,388,389],{"class":178},"}, seed: {default: ",[169,391,380],{"class":315},[169,393,394],{"class":178},"}},\n",[169,396,398,401,403],{"class":171,"line":397},6,[169,399,400],{"class":178},"  gpu: {fragment: ",[169,402,147],{"class":175},[169,404,405],{"class":178},"(reliefBases.stone)},\n",[169,407,409],{"class":171,"line":408},7,[169,410,411],{"class":178},"})\n",[413,414,415],"blockquote",{},[156,416,417,421,422,425],{},[418,419,420],"strong",{},"Tip."," The library shaders build those five props with ",[8,423,424],{},"reliefStylizeProps"," from the utilities, which also sets their sliders.",[256,427,429],{"id":428},"see-also","See also",[431,432,433],"ul",{},[434,435,436,442,443,445,446,449,450,453],"li",{},[437,438,440],"a",{"href":439},"\u002Fdocs\u002Fprimitives\u002Fnoise\u002Freliefbases",[8,441,254],{}," — The height fields ",[8,444,147],{}," accepts: ",[8,447,448],{},"stone"," (marbled stone) and ",[8,451,452],{},"wool"," (interwoven fibres).",[256,455,457],{"id":456},"used-by","Used by",[156,459,460,234,464],{},[437,461,463],{"href":462},"\u002Fdocs\u002Fcomponents\u002Fstone","Stone",[437,465,467],{"href":466},"\u002Fdocs\u002Fcomponents\u002Fwool","Wool",[469,470,471],"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 .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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}html pre.shiki code .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":165,"searchDepth":328,"depth":328,"links":473},[474,475,476,477],{"id":258,"depth":328,"text":259},{"id":298,"depth":328,"text":299},{"id":428,"depth":328,"text":429},{"id":456,"depth":328,"text":457},"Noise",false,"md","light","Noise, light & materials","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fnoise\u002Fnoiserelief",{"title":147,"description":158},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fnoise.ts#L904","docs\u002Fprimitives\u002F12.noise\u002F31.noiserelief","uOWVOVkNBGfQkhsi1Yl_1u7v0H2YYkejjrOa26jYzoc"]