Struct web_glitz::image::texture_2d_array::LevelLayers

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

Returned from Level::layers, a reference to the layers of a Level.

See Level::layers for details.

Implementations

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

pub fn len(&self) -> usize

The number of layers for the level.

Note that each mipmap level for a Texture2DArray as the same number of layers.

pub fn get<'b, I>(&'b self, index: I) -> Option<I::Output> where
    I: LevelLayersIndex<'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;
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_2d_array::Texture2DArrayDescriptor;

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

let base_level = texture.base_level();
let layers = base_level.layers();

assert_eq!(layers.get(1).map(|l| (l.width(), l.height())), Some((128, 128)));
assert_eq!(layers.get(4).map(|l| (l.width(), l.height())), None);

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

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

Example

use web_glitz::image::MipmapLevels;
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_2d_array::Texture2DArrayDescriptor;

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

let base_level = texture.base_level();
let layers = base_level.layers();

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

assert_eq!((layer.width(), layer.height()), (128, 128));

Unsafe

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

pub fn iter(&self) -> LevelLayersIter<'_, F>

Returns an iterator over the layers.

Example

use web_glitz::image::MipmapLevels;
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_2d_array::Texture2DArrayDescriptor;

let texture = context.try_create_texture_2d_array(&Texture2DArrayDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 4,
    levels: MipmapLevels::Complete
}).unwrap();

let base_level = texture.base_level();
let layers = base_level.layers();
let mut iter = layers.iter();

assert!(iter.next().is_some());
assert!(iter.next().is_some());
assert!(iter.next().is_some());
assert!(iter.next().is_some());
assert!(iter.next().is_none());

Trait Implementations

impl<'a, F: Hash> Hash for LevelLayers<'a, F>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

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

type Item = LevelLayer<'a, F>

The type of the elements being iterated over.

type IntoIter = LevelLayersIter<'a, F>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, F: PartialEq> PartialEq<LevelLayers<'a, F>> for LevelLayers<'a, F>

fn eq(&self, other: &LevelLayers<'a, F>) -> bool

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

fn ne(&self, other: &LevelLayers<'a, F>) -> bool

This method tests for !=.

impl<'a, F> StructuralPartialEq for LevelLayers<'a, F>