Skip to main content

JpegOutputBuffer

Struct JpegOutputBuffer 

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

Caller-owned reusable host pixel buffer.

The buffer uses a tight stride by default and can be resized across viewport reads. Resizing to a same-or-smaller byte requirement keeps existing vector capacity, so callers can reuse allocations while still passing ordinary &mut [u8] slices into decode APIs.

Implementations§

Source§

impl JpegOutputBuffer

Source

pub fn new( dimensions: (u32, u32), fmt: PixelFormat, ) -> Result<Self, BufferError>

Create a tightly packed output buffer for dimensions and fmt.

Uses the shared default host allocation cap.

§Errors

Returns BufferError if the requested shape overflows byte counts, exceeds the default host allocation cap, or cannot be reserved.

Source

pub fn with_stride( dimensions: (u32, u32), stride: usize, fmt: PixelFormat, ) -> Result<Self, BufferError>

Create an output buffer with an explicit row stride.

Uses the shared default host allocation cap.

§Errors

Returns BufferError if the stride is too small, sizes overflow, the allocation exceeds the default host allocation cap, or reservation fails.

Source

pub fn resize( &mut self, dimensions: (u32, u32), fmt: PixelFormat, ) -> Result<(), BufferError>

Resize to a tightly packed output shape.

Uses the shared default host allocation cap.

Existing decoded bytes may be discarded when the allocation must grow or stale capacity exceeds the active cap.

§Errors

Returns BufferError if the requested shape overflows byte counts, exceeds the default host allocation cap, or cannot be reserved.

Source

pub fn resize_with_stride( &mut self, dimensions: (u32, u32), stride: usize, fmt: PixelFormat, ) -> Result<(), BufferError>

Resize with an explicit row stride.

Uses the shared default host allocation cap. Existing decoded bytes may be discarded when storage must be replaced.

§Errors

Returns BufferError if the stride is too small, sizes overflow, the allocation exceeds the default host allocation cap, or reservation fails.

Source

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

Borrow the decoded pixel bytes.

Source

pub fn as_mut_slice(&mut self) -> &mut [u8]

Mutably borrow the decoded pixel bytes.

Source

pub fn dimensions(&self) -> (u32, u32)

Current dimensions in pixels.

Source

pub fn stride(&self) -> usize

Current row stride in bytes.

Source

pub fn pixel_format(&self) -> PixelFormat

Current pixel format.

Source

pub fn len(&self) -> usize

Current logical byte length.

Source

pub fn is_empty(&self) -> bool

Whether the logical byte length is zero.

Source

pub fn capacity(&self) -> usize

Retained vector capacity in bytes.

Trait Implementations§

Source§

impl Debug for JpegOutputBuffer

Source§

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

Formats the value using the given formatter. Read more

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.