[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpaint\u002Ftone":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":209,"categorySlug":209,"categoryTitle":455,"curated":456,"description":157,"editUrl":9,"extension":457,"group":209,"groupTitle":458,"kind":459,"meta":460,"navigation":461,"path":462,"seo":463,"sourceUrl":464,"stem":465,"wordCount":9,"__hash__":466},"primitives\u002Fdocs\u002Fprimitives\u002F6.paint\u002F9.tone.md","tone",{"type":149,"value":150,"toc":449},"minimark",[151,154,158,204,219,237,242,293,297,396,409,413,435,439,445],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"Reshapes a 0–1 field with glow, contrast and balance controls, then flips it.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","tone(\n  field: Field,\n  opts: {glow: FieldScalar; contrast: FieldScalar; balance: FieldScalar; invert: true},\n): Field\n","ts","",[8,166,167,179,185,198],{"__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},"  field: Field,\n",[168,186,188,191,195],{"class":170,"line":187},3,[168,189,190],{"class":177},"  opts: {glow: FieldScalar; contrast: FieldScalar; balance: FieldScalar; invert: ",[168,192,194],{"class":193},"sDLfK","true",[168,196,197],{"class":177},"},\n",[168,199,201],{"class":170,"line":200},4,[168,202,203],{"class":177},"): Field\n",[155,205,206,207,210,211,214,215,218],{},"Import ",[8,208,209],{},"paint"," from ",[8,212,213],{},"shaders\u002Fstd"," and use ",[8,216,217],{},"paint.tone",".",[155,220,221,224,225,228,229,232,233,236],{},[8,222,223],{},"glow"," is a spread control: 5 leaves the field alone, lower values pull the bright parts into tight cores, higher values spread them into a wash. ",[8,226,227],{},"contrast"," scales around the middle, 1 is neutral. ",[8,230,231],{},"balance"," is 0–100 with 50 neutral. ",[8,234,235],{},"invert"," is always true: the result is flipped so the palette's first color lands where the field is high.",[238,239,241],"h2",{"id":240},"parameters","Parameters",[243,244,245,261],"table",{},[246,247,248],"thead",{},[249,250,251,255,258],"tr",{},[252,253,254],"th",{},"Name",[252,256,257],{},"Type",[252,259,260],{},"Notes",[262,263,264,279],"tbody",{},[249,265,266,272,277],{},[267,268,269],"td",{},[8,270,271],{},"field",[267,273,274],{},[8,275,276],{},"Field",[267,278],{},[249,280,281,286,291],{},[267,282,283],{},[8,284,285],{},"opts",[267,287,288],{},[8,289,290],{},"{glow: FieldScalar; contrast: FieldScalar; balance: FieldScalar; invert: true}",[267,292],{},[238,294,296],{"id":295},"example","Example",[159,298,300],{"className":161,"code":299,"language":163,"meta":164,"style":164},"paint: rampOver(tone(scaledVolume(noiseField('mx3'), {scale: p('scale')}), {glow: p('intensity'), contrast: p('contrast'), balance: p('balance'), invert: true}), stops(p('colorSpace')))\n",[8,301,302],{"__ignoreMap":164},[168,303,304,306,309,312,315,317,319,322,324,327,329,333,336,338,340,343,346,348,350,353,356,358,360,363,366,368,370,373,376,378,381,384,386,388,390,393],{"class":170,"line":171},[168,305,209],{"class":174},[168,307,308],{"class":177},": ",[168,310,311],{"class":174},"rampOver",[168,313,314],{"class":177},"(",[168,316,147],{"class":174},[168,318,314],{"class":177},[168,320,321],{"class":174},"scaledVolume",[168,323,314],{"class":177},[168,325,326],{"class":174},"noiseField",[168,328,314],{"class":177},[168,330,332],{"class":331},"sU2Wk","'mx3'",[168,334,335],{"class":177},"), {scale: ",[168,337,155],{"class":174},[168,339,314],{"class":177},[168,341,342],{"class":331},"'scale'",[168,344,345],{"class":177},")}), {glow: ",[168,347,155],{"class":174},[168,349,314],{"class":177},[168,351,352],{"class":331},"'intensity'",[168,354,355],{"class":177},"), contrast: ",[168,357,155],{"class":174},[168,359,314],{"class":177},[168,361,362],{"class":331},"'contrast'",[168,364,365],{"class":177},"), balance: ",[168,367,155],{"class":174},[168,369,314],{"class":177},[168,371,372],{"class":331},"'balance'",[168,374,375],{"class":177},"), invert: ",[168,377,194],{"class":193},[168,379,380],{"class":177},"}), ",[168,382,383],{"class":174},"stops",[168,385,314],{"class":177},[168,387,155],{"class":174},[168,389,314],{"class":177},[168,391,392],{"class":331},"'colorSpace'",[168,394,395],{"class":177},")))\n",[397,398,399],"blockquote",{},[155,400,401,405,406,408],{},[402,403,404],"strong",{},"Tip."," Raising ",[8,407,231],{}," pushes more of the canvas toward the first color.",[238,410,412],{"id":411},"see-also","See also",[414,415,416,427],"ul",{},[417,418,419,426],"li",{},[420,421,423],"a",{"href":422},"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fthreshold",[8,424,425],{},"threshold"," — Turns a signed field (−1 to 1) into a soft 0–1 mask.",[417,428,429,434],{},[420,430,432],{"href":431},"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Fnoisefield",[8,433,326],{}," — A field of smooth noise in the chosen flavor.",[238,436,438],{"id":437},"used-by","Used by",[155,440,441],{},[420,442,444],{"href":443},"\u002Fdocs\u002Fcomponents\u002Fplasma","Plasma",[446,447,448],"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 .sDLfK, html code.shiki .sDLfK{--shiki-default:#79B8FF}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":164,"searchDepth":181,"depth":181,"links":450},[451,452,453,454],{"id":240,"depth":181,"text":241},{"id":295,"depth":181,"text":296},{"id":411,"depth":181,"text":412},{"id":437,"depth":181,"text":438},"Fields, palettes & ramps",false,"md","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpaint\u002Ftone",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Ffields.ts#L418","docs\u002Fprimitives\u002F6.paint\u002F9.tone","Pz_Si2vHJbkU8PjcSVRfOnfm8ENAD9K2C2fzQS3WUl4"]