Struct image_texel::image::ImageMut

source · [−]

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

Expand description

A writeable reference to an image buffer.

Implementations

source

impl<'data, L> ImageMut<'data, L>

source

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

Get a reference to those bytes used by the layout.

source

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

Get a mutable reference to those bytes used by the layout.

source

pub fn layout(&self) -> &L

source

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

Get a view of this image.

source

pub fn as_mut(&mut self) -> ImageMut<'_, &mut L>

Get a mutable view of this image.

source

pub fn into_ref(self) -> ImageRef<'data, L>

Convert to a view of this image.

source

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

Check if a call to ImageMut::with_layout would succeed, without consuming this reference.

source

pub fn with_layout<M>(self, layout: M) -> Option<ImageMut<'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 ImageMut::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.

source

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

Decay into a image with less specific layout.

See Image::decay.

source

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

Copy the bytes and layout to an owned container.

source

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

Get a slice of the individual samples in the layout.

source

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

Get a mutable slice of the individual samples in the layout.

source

pub fn as_texels(&self, pixel: Texel) -> &[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.

source

pub fn as_mut_texels(&mut self, pixel: Texel) -> &mut [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_mut_slice.

source

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.

source

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

Turn into a mutable 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.

source

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

Retrieve a single texel from a raster image.

source

pub fn put_texel(&mut self, coord: Coord, texel: P) where
L: RasterMut,

Put a single texel to a raster image.

source

pub fn shade(&mut self, f: impl FnMut(u32, u32, &mut P)) where
L: RasterMut,

Call a function on each texel of this raster image.

The order of evaluation is not defined although certain layouts may offer more specific guarantees. In general, one can expect that layouts call the function in a cache-efficient manner if they are aware of a better iteration strategy.