Struct CubemapDescriptor 

pub struct CubemapDescriptor {
    pub size: u32,
    pub format: TextureFormat,
    pub faces: Option<[Vec<u8>; 6]>,
    pub face_files: Option<[&'static str; 6]>,
    pub generate_mips: bool,
}

Source data for GPUCubemap. Prefer the from_files/from_faces/ empty constructors over setting fields by hand.

Fields

size: u32

Edge length in pixels — cubemap faces are always square.

format: TextureFormat

GPU pixel format to upload as. Defaults to Rgba8UnormSrgb.

faces: Option<[Vec<u8>; 6]>

Some uploads 6 faces of pixel data up front (wgpu’s expected order: +X, -X, +Y, -Y, +Z, -Z). None allocates an empty cubemap meant to be filled later by rendering into per-face views — e.g. an environment-map capture pass — in which case wgpu_descriptor adds RENDER_ATTACHMENT usage instead of requiring upload data.

face_files: Option<[&'static str; 6]>

File paths for each of the 6 faces (same order as faces), decoded through the same loader used by GPUTexture/GPUTextureArray.

generate_mips: bool

Whether to generate a full mip chain (via MipmapGenerator). Only applies when uploading pixel data (faces/face_files set) — meaningless for an empty render-target cubemap.

Implementations

impl CubemapDescriptor

pub fn from_files(size: u32, files: [&'static str; 6]) -> Self

Load 6 faces from files (+X, -X, +Y, -Y, +Z, -Z). Size is inferred from the first face.

pub fn from_faces(size: u32, format: TextureFormat, faces: [Vec<u8>; 6]) -> Self

Supply raw pixel bytes for each face (+X, -X, +Y, -Y, +Z, -Z).

pub fn empty(size: u32, format: TextureFormat) -> Self

Allocate an empty cubemap for use as a render target (e.g. environment capture).

pub fn with_format(self, format: TextureFormat) -> Self

Override the format set by whichever constructor was used (all three default to or take format directly — this exists for the builder-chain case, e.g. CubemapDescriptor::empty(size, format).with_mips() followed later by a format change, without re-specifying size).

pub fn with_mips(self) -> Self

Enable full mip chain generation.