Struct ScreenImageItem 

#[non_exhaustive]
pub struct ScreenImageItem {
    pub pixels: Vec<[u8; 4]>,
    pub width: u32,
    pub height: u32,
    pub anchor: ImageAnchor,
    pub scale: f32,
    pub alpha: f32,
    pub depth: Option<Vec<f32>>,
}

A floating screen-space RGBA image rendered as a viewport overlay.

The image is drawn after all 3D geometry and anchored to one of the viewport corners or the center.

Migration note

If you do not need depth compositing against scene geometry, prefer [OverlayImageItem] in [OverlayFrame] instead. OverlayImageItem has no depth field and renders after post-processing alongside other semantic overlays (labels, scalar bars, rulers).

Depth compositing (Phase 12)

When depth is Some, the image composites against 3D scene geometry: pixels whose depth value exceeds the scene depth at that screen position are discarded, so near geometry occludes the image correctly.

depth must contain exactly width * height f32 values in row-major, top-to-bottom order. Each value is an NDC depth in [0.0, 1.0] where 0.0 = near plane and 1.0 = far plane, matching wgpu’s depth convention.

Depth compositing is only active in the full render() path. When using paint() / paint_to() (external render passes), the image is drawn without a depth test regardless of this field.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pixels: Vec<[u8; 4]>

RGBA8 pixel data, row-major, top-to-bottom.

width: u32

Image width in pixels.

height: u32

Image height in pixels.

anchor: ImageAnchor

Which corner (or center) of the viewport to anchor the image to.

scale: f32

Scale factor relative to natural pixel size (1.0 = one pixel per screen pixel).

alpha: f32

Overall opacity multiplier applied on top of per-pixel alpha. Default: 1.0.

depth: Option<Vec<f32>>

Per-pixel NDC depth values [0.0, 1.0] for depth compositing against scene geometry. Must contain exactly width * height values if Some. None (default) renders the image on top of all geometry (no depth test).

Trait Implementations

impl Clone for ScreenImageItem

fn clone(&self) -> ScreenImageItem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ScreenImageItem

fn default() -> Self

Returns the “default value” for a type.