Struct PixelBuffer 

pub struct PixelBuffer { /* private fields */ }

A frame read back from a renderer, as raw pixels.

This is the engine’s own type rather than an image::RgbaImage because the contract is what every renderer implements, and an image codec crate is not something a renderer needs: the consumers that want one — a PNG in test support, a fixture diff, an export — sit above the engine and convert. image was a dependency of this crate for this signature alone.

The layout is fixed so that the boundary needs no negotiation: RGBA8, unpremultiplied, tightly packed, row-major, top-left origin. A backend whose target is BGRA or premultiplied converts while it copies, which is where the swizzle already happens; a backend with other pixel formats widens this type rather than smuggling a second layout through it.

Implementations

impl PixelBuffer

pub fn new(width: u32, height: u32, data: Vec<u8>) -> Result<PixelBuffer, Error>

Wraps data as an image of width by height pixels.

Fails if data is not exactly width * height * 4 bytes, so that the accessors below cannot hand out a buffer shorter than the size they report.

pub fn width(&self) -> u32

The width, in pixels.

pub fn height(&self) -> u32

The height, in pixels.

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

The pixels, RGBA8 and tightly packed.

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

Consumes the buffer, returning its pixels.

Trait Implementations

impl Clone for PixelBuffer

fn clone(&self) -> PixelBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PixelBuffer

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

Formats the value using the given formatter.

impl Eq for PixelBuffer

impl PartialEq for PixelBuffer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PixelBuffer