Struct StencilCubemapArray

pub struct StencilCubemapArray(/* private fields */);

An array of cube textures containing stencil data.

Implementations

impl StencilCubemapArray

pub fn get_internal_format(&self) -> Result<InternalFormat, GetFormatError>

Determines the internal format of this texture.

The backend may not support querying the actual format, in which case an error is returned.

pub fn empty<F>( facade: &F, dimension: u32, array_size: u32, ) -> Result<StencilCubemapArray, TextureCreationError>

where F: Facade + ?Sized,

Creates an empty texture.

No mipmap level (except for the main level) will be allocated or generated.

The texture will contain undefined data.

pub fn empty_with_format<F>( facade: &F, format: StencilFormat, mipmaps: MipmapsOption, dimension: u32, array_size: u32, ) -> Result<StencilCubemapArray, TextureCreationError>

where F: Facade + ?Sized,

Creates an empty texture with a specific format.

The texture (and its mipmaps) will contain undefined data.

pub fn empty_with_mipmaps<F>( facade: &F, mipmaps: MipmapsOption, dimension: u32, array_size: u32, ) -> Result<StencilCubemapArray, TextureCreationError>

where F: Facade + ?Sized,

Creates an empty texture. Specifies whether is has mipmaps.

The texture (and its mipmaps) will contain undefined data.

pub unsafe fn from_id<F: Facade + ?Sized>( facade: &F, format: StencilFormat, id: c_uint, owned: bool, mipmap: MipmapsOption, ty: Dimensions, ) -> StencilCubemapArray

Builds a new texture reference from an existing, externally created OpenGL texture. If owned is true, this reference will take ownership of the texture and be responsible for cleaning it up. Otherwise, the texture must be cleaned up externally, but only after this reference’s lifetime has ended.

pub unsafe fn new_from_fd<F: Facade + ?Sized>( facade: &F, format: StencilFormat, mipmaps: MipmapsOption, ty: Dimensions, params: ImportParameters, fd: File, ) -> Result<StencilCubemapArray, TextureImportError>

Builds a new texture reference from an existing texture, externally created by a foreign API like Vulkan. The texture is imported via an opaque file descriptor. You must make sure all of the texture parameters match those used to create the texture in Vulkan.

pub fn width(&self) -> u32

Returns the width of that image.

pub fn height(&self) -> u32

Returns the height of that image.

pub fn array_size(&self) -> u32

Returns the number of array layers.

pub fn dimensions(&self) -> u32

Returns the dimension of that image.

pub fn get_mipmap_levels(&self) -> u32

Returns the number of mipmap levels of the texture.

The minimum value is 1, since there is always a main texture.

pub fn resident( self, ) -> Result<ResidentTexture, BindlessTexturesNotSupportedError>

Turns the texture into a ResidentTexture.

This allows you to use the texture in a much more efficient way by storing a “reference to it” in a buffer (actually not a reference but a raw pointer).

See the documentation of ResidentTexture for more infos.

pub fn first_layer(&self) -> StencilCubemapArrayLayer<'_>

Access the first layer of this texture.

pub fn layer(&self, layer: u32) -> Option<StencilCubemapArrayLayer<'_>>

Access a single layer of this texture.

pub fn mipmap(&self, level: u32) -> Option<StencilCubemapArrayMipmap<'_>>

Access a single mipmap level of this texture.

pub fn main_level(&self) -> StencilCubemapArrayMipmap<'_>

Access the main mipmap level of this texture.

Methods from Deref<Target = TextureAny>

pub fn get_width(&self) -> u32

Returns the width of the texture.

pub fn get_height(&self) -> Option<u32>

Returns the height of the texture.

pub fn get_depth(&self) -> Option<u32>

Returns the depth of the texture.

pub fn kind(&self) -> TextureKind

Returns the kind of texture.

pub fn dimensions(&self) -> Dimensions

Returns the dimensions of the texture.

pub fn get_array_size(&self) -> Option<u32>

Returns the array size of the texture.

pub fn get_samples(&self) -> Option<u32>

Returns the number of samples of the texture if it is a multisampling texture.

pub fn first_layer(&self) -> TextureAnyLayer<'_>

Returns a structure that represents the first layer of the texture. All textures have a first layer.

pub fn layer(&self, layer: u32) -> Option<TextureAnyLayer<'_>>

Returns a structure that represents a specific layer of the texture.

Non-array textures have only one layer. The number of layers can be queried with get_array_size.

Returns None if out of range.

pub fn get_texture_type(&self) -> Dimensions

Returns the type of the texture (1D, 2D, 3D, etc.).

pub fn get_internal_format(&self) -> Result<InternalFormat, GetFormatError>

Determines the internal format of this texture.

pub fn get_depth_stencil_bits(&self) -> (u16, u16)

Determines the number of depth and stencil bits in the format of this texture.

pub fn get_mipmap_levels(&self) -> u32

Returns the number of mipmap levels of the texture.

pub fn main_level(&self) -> TextureAnyMipmap<'_>

Returns a structure that represents the main mipmap level of the texture.

pub fn mipmap(&self, level: u32) -> Option<TextureAnyMipmap<'_>>

Returns a structure that represents a specific mipmap of the texture.

Returns None if out of range.

pub unsafe fn generate_mipmaps(&self)

Binds this texture and generates mipmaps.

Trait Implementations

impl Debug for StencilCubemapArray

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for StencilCubemapArray

type Target = TextureAny

The resulting type after dereferencing.

fn deref<'a>(&'a self) -> &'a TextureAny

Dereferences the value.

impl GlObject for StencilCubemapArray

type Id = u32

The type of identifier for this object.

fn get_id(&self) -> c_uint

Returns the id of the object.