content: Quad
LowRes
A container that displays visuals at low resolution with optional antialiasing through supersampling.
LowRes combines PixelArt and Filter components to create a low-resolution rendering effect with customizable antialiasing. This is useful for creating retro-style graphics or performance-optimized rendering while maintaining visual quality through supersampling.
Key features:
- Renders content at a lower resolution than display resolution
- Optional antialiasing through supersampling (density > 1)
- Sharp pixel rendering with adjustable sharpness
- Automatic or manual render control
// Create a low-res container for retro graphics
var lowRes = new LowRes();
lowRes.size(320, 240); // Low internal resolution
lowRes.density = 2; // 2x supersampling for antialiasing
lowRes.sharpness = 2.0; // Sharp pixels
// Add content to the low-res container
var sprite = new Quad();
sprite.texture = assets.texture('pixel-art');
lowRes.content.add(sprite);
// Scale up the container to fill screen
lowRes.scale(3); // 3x scale for 960x720 display
Instance Members
sharpness: Float
Controls the sharpness of the pixels. Higher values create sharper, more defined pixel edges.
Common values:
- 1.0: Soft pixels (some blur)
- 2.0: Sharp pixels (recommended for pixel art)
- 4.0: Very sharp pixels
explicitRender: Bool
When true, the content must be manually rendered by calling render(). When false, rendering happens automatically. Useful for controlling when expensive render operations occur.
autoRender: Bool
When true, content is automatically rendered when changes occur. When false, you must manually trigger rendering. This is the inverse of explicitRender.
density: Float
Density value used for supersampling antialiasing. Controls the internal render resolution multiplier.
- 1.0: No supersampling (fastest, no antialiasing)
- 2.0: 2x supersampling (4x pixels, good quality/performance balance)
- 4.0: 4x supersampling (16x pixels, high quality, slower)
Higher values produce smoother edges but require more GPU memory and processing. Use power of 2 values for best results (1, 2, 4).
lowRes.density = 2; // Recommended for most cases
The container where you add your low-resolution content. All visuals added to this container will be rendered at low resolution.
var sprite = new Quad();
lowRes.content.add(sprite); // Add to low-res rendering
new(): Void
Creates a new low-resolution container. Sets up the internal PixelArt and Filter components with default settings. The container automatically resizes its internal components when resized.
Private Members
pixelArt: PixelArt
Internal pixel art container that handles pixel-perfect rendering. Ensures pixels remain sharp and crisp regardless of scaling.
filter: Filter
Internal filter used to create supersampled content. Applies antialiasing when density is greater than 1.
Internal handler that resizes the pixel art and filter components when the container size changes.
Name | Type | Description |
---|---|---|
width |
Float | New width in pixels |
height |
Float | New height in pixels |
Metadata
Name | Parameters |
---|---|
:build |
tracker.macros.EventsMacro.build() |
:autoBuild |
tracker.macros.EventsMacro.build() |
:build |
ceramic.macros.EntityMacro.buildForCompletion() |
:autoBuild |
ceramic.macros.EntityMacro.buildForCompletion() |