Skip to main content

PlanarImageView

spatialrust

Struct PlanarImageView 

Source 
pub struct PlanarImageView<'a, T, const CHANNELS: usize> { /* private fields */ }
Expand description

A read-only, zero-copy planar image view with explicit strides.

Implementations§

Source§

impl<'a, T, const CHANNELS: usize> PlanarImageView<'a, T, CHANNELS>

Source

pub fn new( width: usize, height: usize, row_stride: usize, plane_stride: usize, data: &'a [T], ) -> Result<PlanarImageView<'a, T, CHANNELS>, ImageError>

Creates a planar view. Strides are measured in scalar elements.

Source

pub fn new_with_metadata( width: usize, height: usize, row_stride: usize, plane_stride: usize, data: &'a [T], metadata: ImageMetadata, ) -> Result<PlanarImageView<'a, T, CHANNELS>, ImageError>

Creates a planar view with validated semantic metadata.

Source

pub const fn width(self) -> usize

Returns image width in pixels.

Source

pub const fn height(self) -> usize

Returns image height in pixels.

Source

pub const fn row_stride(self) -> usize

Returns row stride within a plane.

Source

pub const fn plane_stride(self) -> usize

Returns scalar distance between channel-plane origins.

Source

pub const fn layout(self) -> ImageLayout

Returns physical channel layout.

Source

pub const fn metadata(self) -> ImageMetadata

Returns semantic image metadata.

Source

pub fn get(self, channel: usize, x: usize, y: usize) -> Option<&'a T>

Returns one channel value, or None outside image bounds.

Source

pub fn pixel(self, x: usize, y: usize) -> Option<[T; CHANNELS]>
where T: Copy,

Copies one pixel from its channel planes.

Source

pub fn subview( self, region: ImageRegion, ) -> Result<PlanarImageView<'a, T, CHANNELS>, ImageError>

Creates a checked zero-copy planar subview.

Trait Implementations§

Source§

impl<'a, T, const CHANNELS: usize> Clone for PlanarImageView<'a, T, CHANNELS>
where T: Clone,

Source§

fn clone(&self) -> PlanarImageView<'a, T, CHANNELS>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T, const CHANNELS: usize> Debug for PlanarImageView<'a, T, CHANNELS>
where T: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T, const CHANNELS: usize> Copy for PlanarImageView<'a, T, CHANNELS>
where T: Copy,

Auto Trait Implementations§

§

impl<'a, T, const CHANNELS: usize> Freeze for PlanarImageView<'a, T, CHANNELS>

§

impl<'a, T, const CHANNELS: usize> RefUnwindSafe for PlanarImageView<'a, T, CHANNELS>
where T: RefUnwindSafe,

§

impl<'a, T, const CHANNELS: usize> Send for PlanarImageView<'a, T, CHANNELS>
where T: Sync,

§

impl<'a, T, const CHANNELS: usize> Sync for PlanarImageView<'a, T, CHANNELS>
where T: Sync,

§

impl<'a, T, const CHANNELS: usize> Unpin for PlanarImageView<'a, T, CHANNELS>

§

impl<'a, T, const CHANNELS: usize> UnsafeUnpin for PlanarImageView<'a, T, CHANNELS>

§

impl<'a, T, const CHANNELS: usize> UnwindSafe for PlanarImageView<'a, T, CHANNELS>
where T: RefUnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,