[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"guide-nav":3,"doc-\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fditherinks":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":219,"categorySlug":219,"categoryTitle":454,"curated":455,"description":456,"editUrl":9,"extension":457,"group":458,"groupTitle":459,"kind":460,"meta":461,"navigation":462,"path":463,"seo":464,"sourceUrl":465,"stem":466,"wordCount":9,"__hash__":467},"primitives\u002Fdocs\u002Fprimitives\u002F8.patterns\u002F32.ditherinks.md","ditherInks",{"type":149,"value":150,"toc":448},"minimark",[151,155,163,214,229,259,264,299,307,310,314,399,403,434,438,444],[152,153,147],"h1",{"id":154},"ditherinks",[156,157,158,159,162],"p",{},"A dither filter: colors the 0\u002F1 levels from ",[8,160,161],{},"quantise",", either with two colors of your own or with darkened and brightened versions of the layer's own pixels.",[164,165,170],"pre",{"className":166,"code":167,"language":168,"meta":169,"style":169},"language-ts shiki shiki-themes github-dark","ditherInks(slots: {\n    grid: PixelGrid\n    levels: GatherStage\n    mode: PropRef\n    colors: [PropRef, PropRef]\n}): GatherEffect\n","ts","",[8,171,172,184,190,196,202,208],{"__ignoreMap":169},[173,174,177,180],"span",{"class":175,"line":176},"line",1,[173,178,147],{"class":179},"svObZ",[173,181,183],{"class":182},"s95oV","(slots: {\n",[173,185,187],{"class":175,"line":186},2,[173,188,189],{"class":182},"    grid: PixelGrid\n",[173,191,193],{"class":175,"line":192},3,[173,194,195],{"class":182},"    levels: GatherStage\n",[173,197,199],{"class":175,"line":198},4,[173,200,201],{"class":182},"    mode: PropRef\n",[173,203,205],{"class":175,"line":204},5,[173,206,207],{"class":182},"    colors: [PropRef, PropRef]\n",[173,209,211],{"class":175,"line":210},6,[173,212,213],{"class":182},"}): GatherEffect\n",[156,215,216,217,220,221,224,225,228],{},"Import ",[8,218,219],{},"patterns"," from ",[8,222,223],{},"shaders\u002Fstd"," and use ",[8,226,227],{},"patterns.ditherInks",".",[156,230,231,232,235,236,239,240,243,244,247,248,235,251,254,255,258],{},"Goes in ",[8,233,234],{},"effect:",". ",[8,237,238],{},"mode"," is a ",[8,241,242],{},"compileTime: true"," select prop, ",[8,245,246],{},"'custom'"," or ",[8,249,250],{},"'source'",[8,252,253],{},"colors"," is ",[8,256,257],{},"[dark, light]"," for custom mode; a transparent dark color lets the background show through.",[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],"tbody",{},[271,287,288,294,297],{},[289,290,291],"td",{},[8,292,293],{},"slots",[289,295,296],{},"`{",[289,298],{},[164,300,305],{"className":301,"code":303,"language":304},[302],"language-text","grid: PixelGrid\nlevels: GatherStage\nmode: PropRef\ncolors: [PropRef, PropRef]\n","text",[8,306,303],{"__ignoreMap":169},[156,308,309],{},"}` |  |",[260,311,313],{"id":312},"example","Example",[164,315,317],{"className":166,"code":316,"language":168,"meta":169,"style":169},"effect: ditherInks({grid, levels: quantise({grid, pattern: p('pattern'), threshold: p('threshold'), spread: p('spread')}), mode: p('colorMode'), colors: [p('colorA'), p('colorB')]})\n",[8,318,319],{"__ignoreMap":169},[173,320,321,324,327,329,332,334,337,339,342,346,349,351,353,356,359,361,363,366,369,371,373,376,379,381,383,386,389,391,393,396],{"class":175,"line":176},[173,322,323],{"class":179},"effect",[173,325,326],{"class":182},": ",[173,328,147],{"class":179},[173,330,331],{"class":182},"({grid, levels: ",[173,333,161],{"class":179},[173,335,336],{"class":182},"({grid, pattern: ",[173,338,156],{"class":179},[173,340,341],{"class":182},"(",[173,343,345],{"class":344},"sU2Wk","'pattern'",[173,347,348],{"class":182},"), threshold: ",[173,350,156],{"class":179},[173,352,341],{"class":182},[173,354,355],{"class":344},"'threshold'",[173,357,358],{"class":182},"), spread: ",[173,360,156],{"class":179},[173,362,341],{"class":182},[173,364,365],{"class":344},"'spread'",[173,367,368],{"class":182},")}), mode: ",[173,370,156],{"class":179},[173,372,341],{"class":182},[173,374,375],{"class":344},"'colorMode'",[173,377,378],{"class":182},"), colors: [",[173,380,156],{"class":179},[173,382,341],{"class":182},[173,384,385],{"class":344},"'colorA'",[173,387,388],{"class":182},"), ",[173,390,156],{"class":179},[173,392,341],{"class":182},[173,394,395],{"class":344},"'colorB'",[173,397,398],{"class":182},")]})\n",[260,400,402],{"id":401},"see-also","See also",[404,405,406,417,425],"ul",{},[407,408,409,416],"li",{},[410,411,413],"a",{"href":412},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fpixelgrid",[8,414,415],{},"pixelGrid"," — The pixel grid of a dither: the layer inside it chopped into square cells of a given size.",[407,418,419,424],{},[410,420,422],{"href":421},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fquantise",[8,423,161],{}," — Reduces each grid cell of the layer inside to 0 or 1 using a dither pattern.",[407,426,427,433],{},[410,428,430],{"href":429},"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fdotscreen",[8,431,432],{},"dotScreen"," — A classic halftone filter: the layer inside it redrawn as a grid of dots that grow where it is bright.",[260,435,437],{"id":436},"used-by","Used by",[156,439,440],{},[410,441,443],{"href":442},"\u002Fdocs\u002Fcomponents\u002Fdither","Dither",[445,446,447],"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 .sU2Wk, html code.shiki .sU2Wk{--shiki-default:#9ECBFF}",{"title":169,"searchDepth":186,"depth":186,"links":449},[450,451,452,453],{"id":262,"depth":186,"text":263},{"id":312,"depth":186,"text":313},{"id":401,"depth":186,"text":402},{"id":436,"depth":186,"text":437},"Patterns & tiling",false,"A dither filter: colors the 0\u002F1 levels from `quantise`, either with two colors of your own or with darkened and brightened versions of the layer's own pixels.","md","paint","Painting","function",{},true,"\u002Fdocs\u002Fprimitives\u002Fpatterns\u002Fditherinks",{"title":147,"description":456},"https:\u002F\u002Fgithub.com\u002Fshader-effects-inc\u002Fshaders\u002Fblob\u002Fmain\u002Fpackages\u002Fcore\u002Fsrc\u002Fstd\u002Fpaint\u002Fpatterns.ts#L1124","docs\u002Fprimitives\u002F8.patterns\u002F32.ditherinks","g5VqMtnkOV7fKw8KCwbr_PWLJyEo1bw6uTePsqgNb40"]