Struct gli_rs::TextureCube

#[repr(transparent)]
pub struct TextureCube { /* fields omitted */ }

Cube map texture

Methods

impl TextureCube

pub fn new_empty() -> TextureCube

Create an empty texture cube.

pub fn new(format: Format, extent: Extent2d, levels: usize) -> TextureCube

Create a texture_cube.hpp and allocate a new storage_linear.

pub fn new_with_mipmap_chain(format: Format, extent: Extent2d) -> TextureCube

Create a texture_cube.hpp and allocate a new storage_linear with a complete mipmap chain.

pub fn new_from(texture: &impl GliTexture) -> TextureCube

Create a texture_cube.hpp view with an existing storage_linear.

pub fn new_detail(
    texture: &impl GliTexture,
    format: Format,
    base_layer: usize,
    max_layer: usize,
    base_face: usize,
    max_face: usize,
    base_level: usize,
    max_level: usize
) -> TextureCube

Create a texture_cube.hpp view with an existing storage_linear.

pub fn new_from_subset(
    texture: &TextureCube,
    base_layer: usize,
    max_layer: usize,
    base_level: usize,
    max_level: usize
) -> TextureCube

Create a texture_cube.hpp view, reference a subset of an existing texture_cube.hpp instance.

pub fn get_face(&self, face: usize) -> Texture2D

Create a view of the texture identified by Face in the texture cube.

This method is equivalent to [] operator in C++ version.

Trait Implementations

impl Eq for TextureCube

impl GliTexture for TextureCube

const TARGET_TYPE: Target

type ExtentType = Extent2d

fn extent(&self, level: usize) -> Self::ExtentType

Return the corresponding extent type of the texture instance, which represents the size of a specific mip-level of this texture(width, height and depth).

fn set_swizzles(&mut self, swizzles: Swizzles)

fn base_face(&self) -> usize

Return the base face of the texture instance, effectively a memory offset in the actual texture storage_type to identify where to start reading the faces.

fn base_layer(&self) -> usize

Return the base layer of the texture instance, effectively a memory offset in the actual texture storage_type to identify where to start reading the layers.

fn base_level(&self) -> usize

Return the base level of the texture instance, effectively a memory offset in the actual texture storage_type to identify where to start reading the levels.

fn clear(&mut self)

Clear the entire texture storage_linear with zeros.

fn copy(
    &mut self,
    src_texture: &Self,
    src_layer: usize,
    src_face: usize,
    src_level: usize,
    dst_layer: usize,
    dst_face: usize,
    dst_level: usize
)

Copy a specific image of a texture.

fn copy_subset(
    &mut self,
    src_texture: &Self,
    src_layer: usize,
    src_face: usize,
    src_level: usize,
    src_offset: Extent3d,
    dst_layer: usize,
    dst_face: usize,
    dst_level: usize,
    dst_offset: Extent3d,
    extent: Extent3d
)

Copy a subset of a specific image of a texture.

fn data(&self) -> *const c_void

Return a pointer to the beginning of the texture instance data.

unsafe fn data_mut(&mut self) -> *mut c_void

fn empty(&self) -> bool

Return whether the texture instance is empty, no storage_type or description have been assigned to the instance.

fn faces(&self) -> usize

Return max_face() - base_face() + 1.

fn format(&self) -> Format

Return the texture instance format.

fn layers(&self) -> usize

Return max_layer() - base_layer() + 1.

fn levels(&self) -> usize

Return max_level() - base_level() + 1.

fn max_face(&self) -> usize

Return the max face of the texture instance, effectively a memory offset to the beginning of the last face in the actual texture storage_type that the texture instance can access.

fn max_layer(&self) -> usize

Return the max layer of the texture instance, effectively a memory offset to the beginning of the last layer in the actual texture storage_type that the texture instance can access.

fn max_level(&self) -> usize

Return the max level of the texture instance, effectively a memory offset to the beginning of the last level in the actual texture storage_type that the texture instance can access.

fn size(&self) -> usize

Return the memory size of a texture instance storage_type in bytes.

fn size_at_level(&self, level: usize) -> usize

Return the memory size of a specific level identified by Level.

fn target(&self) -> Target

Return the target of a texture instance.

impl PartialEq<TextureCube> for TextureCube

fn eq(&self, other: &TextureCube) -> bool

Compare two textures. Two textures are the same when the data, the format and the targets are the same.

fn ne(&self, other: &TextureCube) -> bool

Compare two textures. Two textures are the same when the data, the format and the targets are the same.