Struct Snapshot

pub struct Snapshot<T = SnapshotData> {
    size: Size2D<u32>,
    data: T,
    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: T

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<T> Snapshot<T>

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

pub const fn format(&self) -> SnapshotPixelFormat

pub const fn alpha_mode(&self) -> SnapshotAlphaMode

impl Snapshot<SnapshotData>

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 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 as_bytes( &mut self, target_alpha_mode: Option<SnapshotAlphaMode>, target_format: Option<SnapshotPixelFormat>, ) -> (&mut [u8], SnapshotAlphaMode, SnapshotPixelFormat)

pub fn to_vec( self, target_alpha_mode: Option<SnapshotAlphaMode>, target_format: Option<SnapshotPixelFormat>, ) -> (Vec<u8>, SnapshotAlphaMode, SnapshotPixelFormat)

pub fn as_ipc(self) -> Snapshot<IpcSharedMemory>

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

impl Snapshot<IpcSharedMemory>

pub fn to_owned(self) -> Snapshot<SnapshotData>

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

pub fn to_ipc_shared_memory(self) -> IpcSharedMemory

Trait Implementations

impl<T: Clone> Clone for Snapshot<T>

fn clone(&self) -> Snapshot<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Snapshot<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Snapshot<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> MallocSizeOf for Snapshot<T>

where T: MallocSizeOf,

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.

impl<T> Serialize for Snapshot<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.