[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fquantise":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":184,"categorySlug":184,"categoryTitle":402,"curated":403,"description":157,"editUrl":9,"extension":404,"group":405,"groupTitle":406,"kind":407,"meta":408,"navigation":409,"path":410,"seo":411,"sourceUrl":412,"stem":413,"wordCount":9,"__hash__":414},"primitives\u002Fdocs\u002Fprimitives\u002F8.patterns\u002F31.quantise.md","quantise",{"type":149,"value":150,"toc":395},"minimark",[151,154,158,179,194,240,245,282,286,342,352,356,381,385,391],[152,153,147],"h1",{"id":147},[155,156,157],"p",{},"Reduces each grid cell of the layer inside to 0 or 1 using a dither pattern.",[159,160,165],"pre",{"className":161,"code":162,"language":163,"meta":164,"style":164},"language-ts shiki shiki-themes github-dark","quantise(slots: {grid: PixelGrid; pattern: PropRef; threshold: PropRef; spread: PropRef}): GatherStage\n","ts","",[8,166,167],{"__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","(slots: {grid: PixelGrid; pattern: PropRef; threshold: PropRef; spread: PropRef}): GatherStage\n",[155,180,181,182,185,186,189,190,193],{},"Import ",[8,183,184],{},"patterns"," from ",[8,187,188],{},"shaders\u002Fstd"," and use ",[8,191,192],{},"patterns.quantise",".",[155,195,196,197,200,201,204,205,208,209,212,213,212,216,212,219,212,222,212,225,228,229,200,232,235,236,239],{},"Returns a per-pixel level for ",[8,198,199],{},"ditherInks",". ",[8,202,203],{},"pattern"," is a ",[8,206,207],{},"compileTime: true"," select prop with one of ",[8,210,211],{},"bayer2",", ",[8,214,215],{},"bayer4",[8,217,218],{},"bayer8",[8,220,221],{},"clusteredDot",[8,223,224],{},"blueNoise",[8,226,227],{},"whiteNoise"," or ",[8,230,231],{},"floydSteinberg",[8,233,234],{},"threshold"," 0–1 shifts the cut point; 0.5 is neutral. ",[8,237,238],{},"spread"," 0–1 is how much of the brightness range dithers; lower leaves more solid areas.",[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],"tbody",{},[252,268,269,275,280],{},[270,271,272],"td",{},[8,273,274],{},"slots",[270,276,277],{},[8,278,279],{},"{grid: PixelGrid; pattern: PropRef; threshold: PropRef; spread: PropRef}",[270,281],{},[241,283,285],{"id":284},"example","Example",[159,287,289],{"className":161,"code":288,"language":163,"meta":164,"style":164},"const levels = quantise({grid, pattern: p('pattern'), threshold: p('threshold'), spread: p('spread')})\n",[8,290,291],{"__ignoreMap":164},[168,292,293,297,301,304,307,310,312,315,319,322,324,326,329,332,334,336,339],{"class":170,"line":171},[168,294,296],{"class":295},"snl16","const",[168,298,300],{"class":299},"sDLfK"," levels",[168,302,303],{"class":295}," =",[168,305,306],{"class":174}," quantise",[168,308,309],{"class":177},"({grid, pattern: ",[168,311,155],{"class":174},[168,313,314],{"class":177},"(",[168,316,318],{"class":317},"sU2Wk","'pattern'",[168,320,321],{"class":177},"), threshold: ",[168,323,155],{"class":174},[168,325,314],{"class":177},[168,327,328],{"class":317},"'threshold'",[168,330,331],{"class":177},"), spread: ",[168,333,155],{"class":174},[168,335,314],{"class":177},[168,337,338],{"class":317},"'spread'",[168,340,341],{"class":177},")})\n",[343,344,345],"blockquote",{},[155,346,347,351],{},[348,349,350],"strong",{},"Tip."," Floyd–Steinberg is the costliest pattern: it re-reads 64 cells per pixel. Bayer 4 is the cheap default.",[241,353,355],{"id":354},"see-also","See also",[357,358,359,370],"ul",{},[360,361,362,369],"li",{},[363,364,366],"a",{"href":365},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fpixelgrid",[8,367,368],{},"pixelGrid"," — The pixel grid of a dither: the layer inside it chopped into square cells of a given size.",[360,371,372,377,378,380],{},[363,373,375],{"href":374},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fditherinks",[8,376,199],{}," — A dither filter: colors the 0\u002F1 levels from ",[8,379,147],{},", either with two colors of your own or with darkened and brightened versions of the layer's own pixels.",[241,382,384],{"id":383},"used-by","Used by",[155,386,387],{},[363,388,390],{"href":389},"\u002Fdocs\u002Fcomponents\u002Fdither","Dither",[392,393,394],"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 .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 .snl16, html code.shiki .snl16{--shiki-default:#F97583}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":164,"searchDepth":396,"depth":396,"links":397},2,[398,399,400,401],{"id":243,"depth":396,"text":244},{"id":284,"depth":396,"text":285},{"id":354,"depth":396,"text":355},{"id":383,"depth":396,"text":384},"Patterns & tiling",false,"md","paint","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fquantise",{"title":147,"description":157},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fpatterns.ts#L1079","docs\u002Fprimitives\u002F8.patterns\u002F31.quantise","XWqQrUoI9wtm0mGrMhUqsfva2-39u7Vw4Pj9DPKP4vQ"]