Struct CapturedFrame

pub struct CapturedFrame {
    pub width: u32,
    pub height: u32,
    pub format: CapturedFrameFormat,
    pub rgba: Vec<u8>,
    pub png_data: Option<Vec<u8>>,
}

A captured frame read back from a render target.

rgba is always available. png_data is None when PNG encoding was not requested and Some only after a successful encode.

Examples

use ailloli_ui_render_wgpu::{CapturedFrame, CapturedFrameFormat};
let frame = CapturedFrame {
    width: 1,
    height: 1,
    format: CapturedFrameFormat::Rgba8,
    rgba: vec![255, 0, 0, 255],
    png_data: None,
};
assert_eq!(frame.rgba.len(), frame.width as usize * frame.height as usize * 4);

Fields

width: u32

Frame width in physical pixels.

height: u32

Frame height in physical pixels.

format: CapturedFrameFormat

Byte layout used by Self::rgba.

rgba: Vec<u8>

Tight RGBA8 buffer (width * height * 4).

png_data: Option<Vec<u8>>

Optional PNG-encoded bytes for easy artifact writing.

Trait Implementations

impl Clone for CapturedFrame

fn clone(&self) -> CapturedFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapturedFrame

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

Formats the value using the given formatter.

impl PartialEq for CapturedFrame

fn eq(&self, other: &CapturedFrame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CapturedFrame

impl StructuralPartialEq for CapturedFrame