Struct Snapshot

pub struct Snapshot<T = Data> {
    pub(crate) size: Size2D<u64>,
    pub(crate) data: T,
    pub(crate) format: PixelFormat,
    pub(crate) alpha_mode: AlphaMode,
}

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<u64>

data: T

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

format: PixelFormat

RGBA/BGRA (reflect internal data)

alpha_mode: AlphaMode

How to treat alpha channel

Implementations

impl<T> Snapshot<T>

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

pub const fn format(&self) -> PixelFormat

pub const fn alpha_mode(&self) -> AlphaMode

pub const fn is_premultiplied(&self) -> bool

pub const fn is_opaque(&self) -> bool

impl Snapshot<Data>

pub fn empty() -> Self

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

Returns snapshot with provided size that is black transparent alpha

pub fn from_vec( size: Size2D<u64>, format: PixelFormat, alpha_mode: AlphaMode, data: Vec<u8>, ) -> Self

pub fn from_shared_memory( size: Size2D<u64>, format: PixelFormat, alpha_mode: AlphaMode, ism: IpcSharedMemory, ) -> Self

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

pub fn transform( &mut self, target_alpha_mode: AlphaMode, target_format: PixelFormat, )

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_ipc(self) -> Snapshot<IpcSharedMemory>

pub fn to_vec(self) -> Vec<u8>

impl Snapshot<IpcSharedMemory>

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

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

pub fn to_ipc_shared_memory(self) -> IpcSharedMemory

Trait Implementations

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> 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.