Skip to main content

FrameEncoder

Struct FrameEncoder 

Source
pub struct FrameEncoder { /* private fields */ }
Expand description

Encodes a single frame.

Implementations§

Source§

impl FrameEncoder

Source

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

Creates a new frame encoder.

Source

pub fn new_with_extra_channels( width: usize, height: usize, options: FrameEncoderOptions, num_extra_channels: usize, ) -> Self

Creates a new frame encoder with extra channel support.

Source

pub fn encode_modular( &self, image: &ModularImage, _color_encoding: &ColorEncoding, writer: &mut BitWriter, ) -> Result<()>

Encodes a modular image into a frame.

Source

pub fn num_groups(&self) -> usize

Returns the number of groups in this frame.

Source

pub fn num_groups_x(&self) -> usize

Returns the number of groups in X direction.

Source

pub fn num_groups_y(&self) -> usize

Returns the number of groups in Y direction.

Source

pub fn num_lf_groups(&self) -> usize

Returns the number of LF groups (DC groups). LF groups are 8x the size of regular groups (2048x2048 pixels).

Source

pub fn num_toc_entries(&self, num_passes: usize) -> usize

Returns the number of TOC entries for this frame. Single group: 1 entry Multi-group: 2 + num_lf_groups + num_groups * num_passes

Source

pub fn group_bounds(&self, group_idx: usize) -> (usize, usize, usize, usize)

Get the pixel bounds for a group. Returns (x_start, y_start, x_end, y_end).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.