Struct web_glitz::image::texture_2d_array::Levels

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

Returned from Texture2DArray::levels, a reference to the levels of a Texture2DArray.

See Texture2DArray::levels for details.

Methods

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

pub fn len(&self) -> usize

The number of levels defined for the Texture2DArray.

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

Returns a reference to level 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.create_texture_2d_array(&Texture2DArrayDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 16,
    levels: MipmapLevels::Partial(3)
}).unwrap();

let levels = texture.levels();

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

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

Returns a reference to level 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.create_texture_2d_array(&Texture2DArrayDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    depth: 16,
    levels: MipmapLevels::Partial(3)
}).unwrap();

let levels = texture.levels();

let level = unsafe { levels.get_unchecked(1) };

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

Unsafe

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

Important traits for LevelsIter<'a, F>

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

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

Returns an iterator over the levels.

Example

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

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

let levels = texture.levels();
let mut iter = levels.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((64, 64)));
assert_eq!(iter.next().map(|l| (l.width(), l.height())), Some((32, 32)));
assert_eq!(iter.next().map(|l| (l.width(), l.height())), None);

Trait Implementations

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

type Item = Level<'a, F>

The type of the elements being iterated over.

type IntoIter = LevelsIter<'a, F>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.