Installation
Choose your framework. The registry installs one component file and its PixiJS dependency.
Installation unavailable
The preview is public, but its installable release is still being prepared.
The registry command writes the component to src/lib/components/ui/PaletteDither.svelte and installs its dependencies.
The registry command writes the component to src/components/ui/PaletteDither.tsx and installs its dependencies.
The registry command writes the component to src/components/ui/PaletteDither.vue and installs its dependencies.
Overview
Palette Dither samples an image on a canvas-aligned grid, compares its luminance against a Bayer threshold, and resolves every pixel to one of four explicit palette colors.
The ordered pattern restores the impression of intermediate tones without introducing colors outside the selected palette.
Basic usage
The shader fills its parent. Your layout decides whether that parent is a card, hero, or viewport.
- Use Pixel size to trade fine photographic detail for a more graphic low-resolution texture.
- Dither strength at zero keeps the same palette while removing the spatial threshold pattern.
Component API
Types below match the selected Svelte component.
Additional classes for the parent-sized root element.
- Type
string
URL or data URL of the image reduced to the selected palette.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Deepest color in the quantized palette and letterbox fill.
- Type
string- Default
"#131315"
Second step used for shadow detail.
- Type
string- Default
"#29305F"
Primary contrast color in the four-step palette.
- Type
string- Default
"#5867D3"
Brightest color reserved for image highlights.
- Type
string- Default
"#EEF0FF"
Render-target size of each sampled image block.
- Type
number- Default
2- Range / values
1–12
Blends from plain palette rounding to the ordered Bayer threshold.
- Type
number- Default
1- Range / values
0–1
Expands or compresses luminance before quantization.
- Type
number- Default
1.1- Range / values
0.5–2
Offsets luminance before it is assigned to palette steps.
- Type
number- Default
0- Range / values
-0.4–0.4
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy
Types below match the selected React component.
Additional classes for the parent-sized root element.
- Type
string
URL or data URL of the image reduced to the selected palette.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Deepest color in the quantized palette and letterbox fill.
- Type
string- Default
"#131315"
Second step used for shadow detail.
- Type
string- Default
"#29305F"
Primary contrast color in the four-step palette.
- Type
string- Default
"#5867D3"
Brightest color reserved for image highlights.
- Type
string- Default
"#EEF0FF"
Render-target size of each sampled image block.
- Type
number- Default
2- Range / values
1–12
Blends from plain palette rounding to the ordered Bayer threshold.
- Type
number- Default
1- Range / values
0–1
Expands or compresses luminance before quantization.
- Type
number- Default
1.1- Range / values
0.5–2
Offsets luminance before it is assigned to palette steps.
- Type
number- Default
0- Range / values
-0.4–0.4
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
PaletteDitherHandle- Range / values
pause, resume, reset, resize, destroy
Types below match the selected Vue component.
Additional classes for the parent-sized root element.
- Type
string
URL or data URL of the image reduced to the selected palette.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Deepest color in the quantized palette and letterbox fill.
- Type
string- Default
"#131315"
Second step used for shadow detail.
- Type
string- Default
"#29305F"
Primary contrast color in the four-step palette.
- Type
string- Default
"#5867D3"
Brightest color reserved for image highlights.
- Type
string- Default
"#EEF0FF"
Render-target size of each sampled image block.
- Type
number- Default
2- Range / values
1–12
Blends from plain palette rounding to the ordered Bayer threshold.
- Type
number- Default
1- Range / values
0–1
Expands or compresses luminance before quantization.
- Type
number- Default
1.1- Range / values
0.5–2
Offsets luminance before it is assigned to palette steps.
- Type
number- Default
0- Range / values
-0.4–0.4
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy