Struct web_glitz::image::texture_3d::LevelSubImageLayers

pub struct LevelSubImageLayers<'a, F> { /* fields omitted */ }

Reference to the layers of a LevelSubImage.

See LevelSubImage::layers.

Methods

impl<'a, F> LevelSubImageLayers<'a, F> where
    F: TextureFormat, 

pub fn len(&self) -> usize

The number of layers for the LevelSubImage.

pub fn get<'b, I>(&'b self, index: I) -> Option<I::Output> where
    I: LevelSubImageLayersIndex<'b, F>, 

Returns a reference to the layer at the index, or None if the index is out of bounds.

See also [get_unchecked] for an unsafe variant of this method that does not do any bounds checks.

Example

use web_glitz::image::{MipmapLevels, Region3D};
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_3d::Texture3DDescriptor;

let texture = context.create_texture_3d(&Texture3DDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 16,
    levels: MipmapLevels::Partial(3)
}).unwrap();

let base_level = texture.base_level();
let sub_image = base_level.sub_image(Region3D::Area((0, 0, 0), 128, 128, 8));
let layers = sub_image.layers();

assert!(layers.get(1).is_some());
assert!(layers.get(8).is_none());

pub unsafe fn get_unchecked<'b, I>(&'b self, index: I) -> I::Output where
    I: LevelSubImageLayersIndex<'b, F>, 

Returns a reference to layer at the index, without doing any bounds checks.

Example

use web_glitz::image::{MipmapLevels, Region3D};
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_3d::Texture3DDescriptor;

let texture = context.create_texture_3d(&Texture3DDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 16,
    levels: MipmapLevels::Partial(3)
}).unwrap();

let base_level = texture.base_level();
let sub_image = base_level.sub_image(Region3D::Area((0, 0, 0), 128, 128, 8));
let layers = sub_image.layers();

let layer = unsafe { layers.get_unchecked(1) };

Unsafe

The index must be in bounds. See also [get] for a safe variant of this method that does bounds checks.

Important traits for LevelSubImageLayersIter<'a, F>

impl<'a, F> Iterator for LevelSubImageLayersIter<'a, F> where
    F: TextureFormat,  type Item = LevelLayerSubImage<'a, F>;

pub fn iter(&self) -> LevelSubImageLayersIter<F>

Returns an iterator over the layers.

Example

use web_glitz::image::{MipmapLevels, Region3D};
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_3d::Texture3DDescriptor;

let texture = context.create_texture_3d(&Texture3DDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 16,
    levels: MipmapLevels::Partial(3)
}).unwrap();

let base_level = texture.base_level();
let sub_image = base_level.sub_image(Region3D::Area((0, 0, 0), 128, 128, 3));
let layers = sub_image.layers();
let mut iter = layers.iter();

assert_eq!(iter.next().map(|l| (l.width(), l.height())), Some((128, 128)));
assert_eq!(iter.next().map(|l| (l.width(), l.height())), Some((128, 128)));
assert_eq!(iter.next().map(|l| (l.width(), l.height())), Some((128, 128)));
assert!(iter.next().is_none());

Trait Implementations

impl<'a, F> IntoIterator for LevelSubImageLayers<'a, F> where
    F: TextureFormat, 

type Item = LevelLayerSubImage<'a, F>

The type of the elements being iterated over.

type IntoIter = LevelSubImageLayersIter<'a, F>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.