Struct Snapshot 

pub struct Snapshot {
    size: Size2D<u32>,
    data: SnapshotData,
    format: SnapshotPixelFormat,
    alpha_mode: SnapshotAlphaMode,
}

Represents image bitmap with metadata, usually as snapshot of canvas

This allows us to hold off conversions (BGRA <-> RGBA, (un)premultiply) to when/if they are actually needed (WebGL/WebGPU can load both BGRA and RGBA).

Inspired by snapshot for concept in WebGPU spec: https://gpuweb.github.io/gpuweb/#abstract-opdef-get-a-copy-of-the-image-contents-of-a-context

Fields

size: Size2D<u32>

data: SnapshotData

internal data (can be any format it will be converted on use if needed)

format: SnapshotPixelFormat

RGBA/BGRA (reflect internal data)

alpha_mode: SnapshotAlphaMode

How to treat alpha channel

Implementations

impl Snapshot

pub const fn size(&self) -> Size2D<u32>

pub const fn format(&self) -> SnapshotPixelFormat

pub const fn alpha_mode(&self) -> SnapshotAlphaMode

pub fn empty() -> Self

pub fn cleared(size: Size2D<u32>) -> Self

Returns snapshot with provided size that is black transparent alpha

pub fn from_vec( size: Size2D<u32>, format: SnapshotPixelFormat, alpha_mode: SnapshotAlphaMode, data: Vec<u8>, ) -> Self

pub fn from_shared_memory( size: Size2D<u32>, format: SnapshotPixelFormat, alpha_mode: SnapshotAlphaMode, data: Arc<IpcSharedMemory>, byte_range_bounds: impl RangeBounds<usize>, ) -> Self

pub fn get_rect(&self, rect: Rect<u32>) -> Self

pub fn transform( &mut self, target_alpha_mode: SnapshotAlphaMode, target_format: SnapshotPixelFormat, )

Convert inner data of snapshot to target format and alpha mode. If data is already in target format and alpha mode no work will be done.

pub fn as_raw_bytes(&self) -> &[u8]

pub fn as_raw_bytes_mut(&mut self) -> &mut [u8]

pub fn to_shared(&self) -> SharedSnapshot

pub fn encode_for_mime_type<W: Write>( &mut self, image_type: &EncodedImageType, quality: Option<f64>, encoder: &mut W, ) -> Result<(), ImageError>

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl From<Snapshot> for Vec<u8>

fn from(value: Snapshot) -> Self

Converts to this type from the input type.

impl MallocSizeOf for Snapshot

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.