Struct three_d::core::texture::TextureCubeMap

pub struct TextureCubeMap { /* private fields */ }

A texture that covers all 6 sides of a cube.

Implementations

impl TextureCubeMap

pub fn new(
    context: &Context,
    cpu_texture: &CpuTextureCube
) -> ThreeDResult<Self>

Creates a new texture cube map from the given cpu texture. The cpu texture must contain 6 images all with the width and height specified in the cpu texture. The images are used in the following order; right, left, top, bottom, front, back.

pub fn new_empty<T: TextureDataType>(
    context: &Context,
    width: u32,
    height: u32,
    min_filter: Interpolation,
    mag_filter: Interpolation,
    mip_map_filter: Option<Interpolation>,
    wrap_s: Wrapping,
    wrap_t: Wrapping,
    wrap_r: Wrapping
) -> ThreeDResult<Self>

Creates a new texture cube map.

pub fn fill<T: TextureDataType>(
    &mut self,
    right_data: &[T],
    left_data: &[T],
    top_data: &[T],
    bottom_data: &[T],
    front_data: &[T],
    back_data: &[T]
) -> ThreeDResult<()>

Fills the cube map texture with the given pixel data for the 6 images.

Errors

Returns an error if the length of the data for all 6 images does not correspond to the width, height and format specified at construction. It is therefore necessary to create a new texture if the texture size or format has changed.

pub fn new_from_equirectangular<T: PrimitiveDataType + TextureDataType>(
    context: &Context,
    cpu_texture: &CpuTexture
) -> ThreeDResult<Self>

Creates a new cube texture generated from the equirectangular texture given as input.

pub fn write(
    &mut self,
    side: CubeMapSide,
    clear_state: ClearState,
    render: impl FnOnce() -> ThreeDResult<()>
) -> ThreeDResult<()>

Writes whatever rendered in the render closure into the color texture at the cube map side given by the input parameter side. Before writing, the texture side is cleared based on the given clear state.

pub fn write_to_mip_level(
    &mut self,
    side: CubeMapSide,
    mip_level: u32,
    clear_state: ClearState,
    render: impl FnOnce() -> ThreeDResult<()>
) -> ThreeDResult<()>

Writes whatever rendered in the render closure into the given mip level of the color texture at the cube map side given by the input parameter side. Before writing, the texture side is cleared based on the given clear state.

pub fn width(&self) -> u32

The width of this texture.

pub fn height(&self) -> u32

The height of this texture.

pub fn is_hdr(&self) -> bool

Whether this cube map contain HDR (high dynamic range) data.

Trait Implementations

impl Drop for TextureCubeMap

fn drop(&mut self)

Executes the destructor for this type.