Struct glium::texture::stencil_texture1d::StencilTexture1d
[−]
[src]
pub struct StencilTexture1d(_);
A one-dimensional texture containing stencil data.
Methods
impl StencilTexture1d[src]
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.
fn new<'a, F, T>(facade: &F, data: T) -> Result<StencilTexture1d, TextureCreationError> where T: Texture1dDataSource<'a>, F: Facade
Builds a new texture by uploading data.
This function will automatically generate all mipmaps of the texture.
fn with_mipmaps<'a, F, T>(facade: &F, data: T, mipmaps: MipmapsOption) -> Result<StencilTexture1d, TextureCreationError> where T: Texture1dDataSource<'a>, F: Facade
Builds a new texture by uploading data.
fn with_format<'a, F, T>(facade: &F, data: T, format: StencilFormat, mipmaps: MipmapsOption) -> Result<StencilTexture1d, TextureCreationError> where T: Texture1dDataSource<'a>, F: Facade
Builds a new texture with a specific format.
fn empty<F>(facade: &F, width: u32) -> Result<StencilTexture1d, TextureCreationError> where F: Facade
Creates an empty texture.
No mipmap level (except for the main level) will be allocated or generated.
The texture will contain undefined data.
fn empty_with_format<F>(facade: &F, format: StencilFormat, mipmaps: MipmapsOption, width: u32) -> Result<StencilTexture1d, TextureCreationError> where F: Facade
Creates an empty texture with a specific format.
The texture (and its mipmaps) will contain undefined data.
fn empty_with_mipmaps<F>(facade: &F, mipmaps: MipmapsOption, width: u32) -> Result<StencilTexture1d, TextureCreationError> where F: Facade
Creates an empty texture. Specifies whether is has mipmaps.
The texture (and its mipmaps) will contain undefined data.
unsafe fn from_id<F: Facade>(facade: &F, format: StencilFormat, id: GLuint, owned: bool, mipmap: MipmapsOption, ty: Dimensions) -> StencilTexture1d
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.
fn width(&self) -> u32
Returns the width of that image.
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.
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.
fn mipmap(&self, level: u32) -> Option<StencilTexture1dMipmap>
Access a single mipmap level of this texture.
fn main_level(&self) -> StencilTexture1dMipmap
Access the main mipmap level of this texture.
Methods from Deref<Target=TextureAny>
fn get_width(&self) -> u32
Returns the width of the texture.
fn get_height(&self) -> Option<u32>
Returns the height of the texture.
fn get_depth(&self) -> Option<u32>
Returns the depth of the texture.
fn kind(&self) -> TextureKind
Returns the kind of texture.
fn dimensions(&self) -> Dimensions
Returns the dimensions of the texture.
fn get_array_size(&self) -> Option<u32>
Returns the array size of the texture.
fn get_samples(&self) -> Option<u32>
Returns the number of samples of the texture if it is a multisampling texture.
fn first_layer(&self) -> TextureAnyLayer
Returns a structure that represents the first layer of the texture. All textures have a first layer.
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.
fn get_texture_type(&self) -> Dimensions
Returns the type of the texture (1D, 2D, 3D, etc.).
fn get_internal_format(&self) -> Result<InternalFormat, GetFormatError>
Determines the internal format of this texture.
fn get_mipmap_levels(&self) -> u32
Returns the number of mipmap levels of the texture.
fn main_level(&self) -> TextureAnyMipmap
Returns a structure that represents the main mipmap level of the texture.
fn mipmap(&self, level: u32) -> Option<TextureAnyMipmap>
Returns a structure that represents a specific mipmap of the texture.
Returns None if out of range.
unsafe fn generate_mipmaps(&self)
Binds this texture and generates mipmaps.
Trait Implementations
impl GlObject for StencilTexture1d[src]
type Id = GLuint
The type of identifier for this object.
fn get_id(&self) -> GLuint
Returns the id of the object.
impl Debug for StencilTexture1d[src]
impl Deref for StencilTexture1d[src]
type Target = TextureAny
The resulting type after dereferencing
fn deref<'a>(&'a self) -> &'a TextureAny
The method called to dereference a value
impl<'t> ToStencilAttachment<'t> for &'t StencilTexture1d[src]
fn to_stencil_attachment(self) -> StencilAttachment<'t>
Builds the StencilAttachment.