Struct jxl_oxide::FrameBuffer

pub struct FrameBuffer { /* private fields */ }

Frame buffer representing a decoded image.

Implementations

impl FrameBuffer

pub fn new(width: usize, height: usize, channels: usize) -> Self

Creates a new framebuffer with given dimension.

Note that framebuffer allocations are not tracked.

pub fn width(&self) -> usize

Returns the width of the frame buffer.

pub fn height(&self) -> usize

Returns the height of the frame buffer.

pub fn channels(&self) -> usize

Returns the number of channels of the frame buffer.

pub fn buf(&self) -> &[f32]

Returns the contents of frame buffer.

The buffer has length of width * height * channels, where n * channels + c-th sample belongs to the c-th channel.

pub fn buf_mut(&mut self) -> &mut [f32]

Returns the mutable reference to frame buffer.

The buffer has length of width * height * channels, where n * channels + c-th sample belongs to the c-th channel.

pub fn buf_grouped<const N: usize>(&self) -> &[[f32; N]]

Returns the contents of frame buffer, grouped by pixels.

Panics

Panics if N != self.channels().

pub fn buf_grouped_mut<const N: usize>(&mut self) -> &mut [[f32; N]]

Returns the mutable reference to frame buffer, grouped by pixels.

Panics

Panics if N != self.channels().

Trait Implementations

impl Clone for FrameBuffer

fn clone(&self) -> FrameBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameBuffer

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

Formats the value using the given formatter.