Struct image_texel::image::ImageRef

pub struct ImageRef<'buf, Layout = &'buf Bytes> { /* private fields */ }

A read-only view of an image.

Note that this requires its underlying buffer to be highly aligned! For that reason it is not possible to take a reference at an arbitrary number of bytes.

Implementations

impl<'data, L> ImageRef<'data, L>

pub fn as_bytes(&self) -> &[u8] where
    L: Layout, 

Get a reference to those bytes used by the layout.

pub fn layout(&self) -> &L

pub fn as_ref(&self) -> ImageRef<'_, &L>

Get a view of this image.

pub fn fits(&self, other: &impl Layout) -> bool

Check if a call to ImageRef::with_layout would succeed.

pub fn with_layout<M>(self, layout: M) -> Option<ImageRef<'data, M>> where
    M: Layout, 

Change this view to a different layout.

This returns Some if the layout fits the underlying data, and None otherwise. Use ImageRef::fits to check this property in a separate call. Note that the new layout need not be related to the old layout in any other way.

pub fn decay<M>(self) -> Option<ImageRef<'data, M>> where
    M: Decay<L>,
    M: Layout, 

Decay into a image with less specific layout.

See Image::decay.

pub fn to_owned(&self) -> Image<L> where
    L: Layout + Clone, 

Copy all bytes to a newly allocated image.

pub fn as_slice(&self) -> &[L::Sample] where
    L: SliceLayout, 

Get a slice of the individual samples in the layout.

pub fn as_texels<P>(&self, pixel: Texel<P>) -> &[P]

View this buffer as a slice of pixels.

This reinterprets the bytes of the buffer. It can be used to view the buffer as any kind of pixel, regardless of its association with the layout. Use it with care.

An alternative way to get a slice of texels when a layout has an inherent texel type is Self::as_slice.

pub fn into_slice(self) -> &'data [L::Sample] where
    L: SliceLayout, 

Turn into a slice of the individual samples in the layout.

This preserves the lifetime with which the layout is borrowed from the underlying image, and the ImageMut need not stay alive.

pub fn get_texel<P>(&self, coord: Coord) -> Option<P> where
    L: Raster<P>, 

Retrieve a single texel from a raster image.

Trait Implementations

impl<'buf, Layout: Clone> Clone for ImageRef<'buf, Layout>

fn clone(&self) -> ImageRef<'buf, Layout>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'lt, L> From<&'lt Image<L>> for ImageRef<'lt, &'lt L>

fn from(image: &'lt Image<L>) -> Self

Converts to this type from the input type.

impl<'lt, L: Layout + Clone> From<&'lt Image<L>> for ImageRef<'lt, L>

fn from(image: &'lt Image<L>) -> Self

Converts to this type from the input type.

impl<'lt, L: Layout + Clone> From<ImageRef<'lt, &'_ L>> for ImageRef<'lt, L>

fn from(image: ImageRef<'lt, &L>) -> Self

Converts to this type from the input type.

impl<'lt, L: Layout + Clone> From<ImageRef<'lt, &'_ mut L>> for ImageRef<'lt, L>

fn from(image: ImageRef<'lt, &mut L>) -> Self

Converts to this type from the input type.

impl<'buf, Layout: PartialEq> PartialEq<ImageRef<'buf, Layout>> for ImageRef<'buf, Layout>

fn eq(&self, other: &ImageRef<'buf, Layout>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ImageRef<'buf, Layout>) -> bool

This method tests for !=.

impl<'buf, Layout: Eq> Eq for ImageRef<'buf, Layout>

impl<'buf, Layout> StructuralEq for ImageRef<'buf, Layout>

impl<'buf, Layout> StructuralPartialEq for ImageRef<'buf, Layout>