Struct web_glitz::image::texture_cube::LevelFaceMut

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

A mutable reference to a face of a TextureCube mipmap level.

Derefs to LevelFace.

Methods from Deref<Target = LevelFace<'a, F>>

pub fn level(&self) -> usize

Returns the index that identifies the level this face belongs to.

pub fn face(&self) -> CubeFace

Returns the face referenced by this LevelFace.

pub fn width(&self) -> u32

Returns the width of this LevelFace.

pub fn height(&self) -> u32

Returns the height of this LevelFace.

pub fn sub_image(&self, region: Region2D) -> LevelFaceSubImage<F>

Returns a reference to the sub-region of this LevelFace's image described by region.

Example

This may for example be used to upload data to only a sub-region of an image, rather than the complete image:

use web_glitz::image::{Image2DSource, MipmapLevels, Region2D};
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_cube::TextureCubeDescriptor;

let texture = context.create_texture_cube(&TextureCubeDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    levels: MipmapLevels::Complete
}).unwrap();

let level = texture.base_level();
let face = level.positive_x();
let sub_image = face.sub_image(Region2D::Area((0, 0), 128, 128));

let pixels: Vec<[u8; 3]> = vec![[0, 0, 255]; 128 * 128];
let data = Image2DSource::from_pixels(pixels, 128, 128).unwrap();

context.submit(sub_image.upload_command(data));

The lower left quadrant of the "positive x" face of the texture's base level now contains blue pixels.

pub fn upload_command<D, T>(
    &self,
    data: Image2DSource<D, T>
) -> UploadCommand<D, T, F> where
    T: ClientFormat<F>, 

Returns a command which, when executed, replaces the image data in this LevelFace's image with the image data provided in data.

The image data must be stored in a ClientFormat that is suitable for the texture's TextureFormat.

If the dimensions of the image provided in data are not sufficient to cover the LevelFace's image entirely, starting from the origin, then only the region of overlap is updated (note that the origin of an image is the lower left corner). For example, given a LevelFace with a width of 256 pixels and a height of 256 pixels, and data with a width of 128 pixels and a height of 128 pixels, then only the lower left quadrant of the LevelFace is updated. If the dimensions of the image provided in data would, when starting from the origin, cover more than the Level's image (the width and/or height of data is/are greater than the width and/or height of the Level's image), then any pixels that would fall outside of the LevelFace are ignored. For example, given a LevelFace with a width of 256 pixels and a height of 256 pixels, and data with a width of 256 pixels and a height of 512 pixels, then only the lower half of the image in data is used to update the LevelFace and the upper half is ignored.

Example

This example uploads red pixels to the "positive x" face of the base mipmap level a TextureCube:

use web_glitz::image::{Image2DSource, MipmapLevels};
use web_glitz::image::format::RGB8;
use web_glitz::image::texture_cube::TextureCubeDescriptor;

let texture = context.create_texture_cube(&TextureCubeDescriptor {
    format: RGB8,
    width: 256,
    height: 256,
    levels: MipmapLevels::Complete
}).unwrap();

let pixels: Vec<[u8; 3]> = vec![[255, 0, 0]; 256 * 256];
let data = Image2DSource::from_pixels(pixels, 256, 256).unwrap();

context.submit(texture.base_level().positive_x().upload_command(data));

Trait Implementations

impl<'a, F> AsAttachableImageRef for TextureCubeLevelFaceMut<'a, F> where
    F: TextureFormat, 

type Format = F

The type of image storage format the image is stored in.

fn as_attachable_image_ref(&mut self) -> AttachableImageRef<Self::Format>

Converts the image reference into a render target attachment.

impl<'a, F> Deref for LevelFaceMut<'a, F>

type Target = LevelFace<'a, F>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.