Struct OverlayImageItem 

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

A pixel image composited over the viewport in screen space.

Unlike ScreenImageItem (which lives in SceneFrame and supports depth compositing with world geometry), OverlayImageItem is a pure screen-space overlay with no depth field. It renders after post-processing, on top of all scene content, labels, scalar bars, and rulers.

Consumers using ScreenImageItem without a depth buffer (corner logos, diagnostic HUDs, watermarks) should migrate to OverlayImageItem.

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.

Trait Implementations

impl Clone for OverlayImageItem

fn clone(&self) -> OverlayImageItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OverlayImageItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OverlayImageItem

fn default() -> Self

Returns the “default value” for a type.