Skip to main content

InPlacePixels

Struct InPlacePixels 

Source
#[non_exhaustive]
pub struct InPlacePixels<'a> { pub bytes: &'a mut [u8], pub width: u32, pub rows: u32, pub stride: usize, pub descriptor: PixelDescriptor, pub color: Option<Arc<ColorContext>>, }
Expand description

Everything a layout-changing in-place transform receives from PixelBuffer::transform_in_place: the buffer’s backing bytes (from the aligned base, including stride padding) plus its current description. Plain data — constructible directly (e.g. by transform unit tests exercising arbitrary strides); the staleness protection lives in transform_in_place’s atomic adoption, not here.

#[non_exhaustive]: construct it with InPlacePixels::new (inside transform_in_place the buffer does this for you). Sealing lets future fields — a cancellation token, a separate anchor — be added without a break.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§bytes: &'a mut [u8]

Full backing bytes from the aligned base.

§width: u32

Current width in pixels.

§rows: u32

Current row count.

§stride: usize

Current byte stride between row starts.

§descriptor: PixelDescriptor

Current pixel format descriptor.

§color: Option<Arc<ColorContext>>

Current color context, if any.

Implementations§

Source§

impl<'a> InPlacePixels<'a>

Source

pub fn new( bytes: &'a mut [u8], width: u32, rows: u32, stride: usize, descriptor: PixelDescriptor, color: Option<Arc<ColorContext>>, ) -> InPlacePixels<'a>

Construct directly — the escape hatch for a layout transform invoked outside PixelBuffer::transform_in_place (e.g. a unit test exercising an arbitrary stride). Inside transform_in_place the buffer builds this for you from its own backing bytes and description.

Auto Trait Implementations§

§

impl<'a> !UnwindSafe for InPlacePixels<'a>

§

impl<'a> Freeze for InPlacePixels<'a>

§

impl<'a> RefUnwindSafe for InPlacePixels<'a>

§

impl<'a> Send for InPlacePixels<'a>

§

impl<'a> Sync for InPlacePixels<'a>

§

impl<'a> Unpin for InPlacePixels<'a>

§

impl<'a> UnsafeUnpin for InPlacePixels<'a>

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, 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.