Skip to main content

Image

Struct Image 

Source
pub struct Image {
    pub pixel: PixelFormat,
    pub width: u32,
    pub height: u32,
    pub stride: u32,
    pub data: ImageSamples,
}
Expand description

A raw image frame — std/media/v1/Image[pixel=…], row-major and packed.

Fields§

§pixel: PixelFormat

The pixel format, which selects the sample column’s type.

§width: u32

The frame’s width in pixels.

§height: u32

The frame’s height in pixels.

§stride: u32

The bytes between the starts of two rows; equal to the packed row length for a frame with no padding, which is what this layout carries.

§data: ImageSamples

The samples, width * height * channels of them.

Implementations§

Source§

impl Image

Source

pub fn new( pixel: PixelFormat, width: u32, height: u32, data: ImageSamples, ) -> Result<Self>

A packed frame whose sample count matches its geometry.

stride is computed as the packed row length in bytes.

§Errors

DataError::TypeMismatch when the samples do not match the format’s width, and DataError::ChildLengthMismatch when the sample count is not width * height * channels.

Source

pub const fn channels(&self) -> u8

How many channels one pixel holds.

Source

pub fn urn(&self) -> String

The parameterised URN a port carrying this frame declares.

Source

pub fn layout(&self) -> DataType

The columnar layout this frame produces.

Source

pub fn check(&self) -> Result<()>

Checks that the samples match the format and the geometry.

§Errors

As Image::new.

Source

pub fn to_record_batch(&self) -> Result<RecordBatch>

Encodes the frame as a one-row payload batch.

§Errors

As Image::check, plus DataError when the columns cannot be assembled.

Source

pub fn from_record_batch(batch: &RecordBatch) -> Result<Self>

Decodes a frame from a one-row payload batch.

The pixel format is recovered from the sample column’s type and the stored channel count, so a decoder never needs the port’s URN to read a frame it already holds.

§Errors

DataError when the batch is not an Image layout, or its sample type and channel count name no format in the §24.3 table.

Trait Implementations§

Source§

impl Clone for Image

Source§

fn clone(&self) -> Self

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 Debug for Image

Source§

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

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

impl FromPayload for Image

Source§

fn from_batch(batch: &RecordBatch) -> Result<Self>

Reads the value from a decoded payload batch. Read more
Source§

impl PartialEq for Image

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Image

Auto Trait Implementations§

§

impl Freeze for Image

§

impl RefUnwindSafe for Image

§

impl Send for Image

§

impl Sync for Image

§

impl Unpin for Image

§

impl UnsafeUnpin for Image

§

impl UnwindSafe for Image

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> MaybeDebug for T

Source§

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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