Struct rin::gl::texture::Texture

pub struct Texture { /* fields omitted */ }

Wraps an OpenGL texture + some metadata about it’s format

Implementations

impl Texture

pub fn is_dsa(&self) -> bool

Returns true if the Texture is backed by a DSA backend

pub fn load_data<T>(
    &mut self,
    data: &[T],
    format: DataFormat
) -> Result<(), Error> where
    T: 'static, 

Upload data to the texture

The function will check that the data dimensions are correct for the passed format and the allocated size.

DataFormat implements Default so it usually doesn’t need to be fully specified see it’s documentation for more information.

pub fn load_buffer<T, B>(
    &mut self,
    buffer: &B,
    format: DataFormat
) -> Result<(), Error> where
    B: BufferRange<T>,
    T: 'static, 

Load data to the texture from a Buffer

The function will check that the data dimensions are correct for the passed format and the allocated size

DataFormat implements Default so it usually doesn’t need to be fully specified see it’s documentation for more information.

pub fn load_compressed_data<T>(
    &mut self,
    data: &[T],
    format: CompressedDataFormat
) -> Result<(), Error> where
    T: 'static, 

Upload data to the texture

The function will check that the data dimensions are correct for the passed format and the allocated size. Also that the passed texture format is the same as the allocated internal

CompressedDataFormat implements Default so it usually doesn’t need to be fully specified see it’s documentation for more information.

pub fn load_compressed_buffer<B, T>(
    &mut self,
    buffer: &B,
    format: CompressedDataFormat
) -> Result<(), Error> where
    B: BufferRange<T>,
    T: 'static, 

Load data to the texture from a GPU Buffer

The function will check that the data dimensions are correct for the passed format and the allocated size. Also that the passed texture format is the same as the allocated internal

CompressedDataFormat implements Default so it usually doesn’t need to be fully specified see it’s documentation for more information.

pub fn load_level_from_image<I>(
    &mut self,
    img: &I,
    level: u32
) -> Result<(), Error> where
    I: Image, 

Upload data to a texture level from an image

The function will check that the data dimensions are correct for the passed format and the allocated size

pub fn load_image<I>(&mut self, img: &I) -> Result<(), Error> where
    I: Image, 

Upload data to the texture from an image

If the image has more than one level it’ll try to upload all the levels to the textyre

The function will check that the data dimensions are correct for the passed format and the allocated size

pub fn width(&self) -> u32

Returns the width of the allocated texture

pub fn height(&self) -> u32

Returns the height of the allocated texture

pub fn depth(&self) -> u32

Returns the depth of the allocated texture

pub fn aspect_ratio(&self) -> f32

Returns the aspect ratio of the allocated texture

pub fn size(&self) -> (u32, u32)

Returns the size of the allocated texture as (width, height)

pub fn samples(&self) -> u32

Returns the samples of the allocated texture

pub fn levels(&self) -> u32

Returns the number of allocated levels

pub fn id(&self) -> u32

Returns the GL id

pub fn target(&self) -> u32

Returns the texture target

pub fn internal_format(&self) -> u32

Returns the internal format

pub fn view(&self) -> Texture

pub fn set_rg_to_rgba_swizzles(&mut self)

Swizzle from r -> rgb and g -> a

Useful to show grayscale or alpha + grayscale as grayscale instead of red tinted using the same shader one would use for an rgb(a) texture

pub fn set_swizzle_r(&mut self, component: Component)

Swizzle r -> component

pub fn set_swizzle_g(&mut self, component: Component)

Swizzle g -> component

pub fn set_swizzle_b(&mut self, component: Component)

Swizzle b -> component

pub fn set_swizzle_a(&mut self, component: Component)

Swizzle a -> component

pub fn set_swizzles(&mut self, swizzles: Swizzles)

Sets a group of Swizzles

pub unsafe fn read_to<T>(&self, pixels: &mut [T], format: u32, ty: u32)

Reads back the contents of the texture into the passed pixels

pub unsafe fn read_to_buffer<T, B>(&self, buffer: &mut B, format: u32, ty: u32) where
    B: BufferRange<T>, 

Reads back the contents of the texture into the passed pixels

pub fn set_anisotropy_level(&mut self, level: f32)

GL_TEXTURE_MAX_ANISOTROPY_EXT

pub fn set_base_level(&mut self, level: i32)

GL_TEXTURE_BASE_LEVEL

pub fn set_max_level(&mut self, level: i32)

GL_TEXTURE_MAX_LEVEL

pub fn set_min_lod(&mut self, level: i32)

GL_TEXTURE_MIN_LOD

pub fn set_max_lod(&mut self, level: i32)

GL_TEXTURE_MAX_LOD

pub fn set_min_mag_filters(&mut self, min: u32, mag: u32)

GL_TEXTURE_MIN_MAG_FILTERS

pub fn set_wrap_s(&mut self, wrap: u32)

GL_TEXTURE_WRAP_S

pub fn set_wrap_t(&mut self, wrap: u32)

GL_TEXTURE_WRAP_T

pub fn set_wrap_r(&mut self, wrap: u32)

GL_TEXTURE_WRAP_R

pub fn set_compare_mode(&mut self, mode: u32)

pub fn set_compare_func(&mut self, mode: u32)

pub fn set_border_color(&mut self, color: &[f32; 4])

GL_TEXTURE_BORDER_COLOR

pub fn level_width(&self, level: u32) -> u32

GL_TEXTURE_WIDTH

pub fn level_height(&self, level: u32) -> u32

GL_TEXTURE_HEIGHT

pub fn level_internal_format(&self, level: u32) -> u32

GL_TEXTURE_INTERNAL_FORMAT

pub fn level_red_type(&self, level: u32) -> u32

GL_TEXTURE_RED_TYPE

pub fn level_green_type(&self, level: u32) -> u32

GL_TEXTURE_GREEN_TYPE

pub fn level_blue_type(&self, level: u32) -> u32

GL_TEXTURE_BLUE_TYPE

pub fn level_alpha_type(&self, level: u32) -> u32

GL_TEXTURE_ALPHA_TYPE

pub fn is_level_compressed(&self, level: u32) -> bool

GL_TEXTURE_COMPRESSED

pub fn level_compressed_image_len(&self, level: u32) -> usize

GL_TEXTURE_COMPRESSED_IMAGE_SIZE

pub fn level_red_size(&self, level: u32) -> usize

GL_TEXTURE_RED_SIZE

pub fn level_green_size(&self, level: u32) -> usize

GL_TEXTURE_GREEN_SIZE

pub fn level_blue_size(&self, level: u32) -> usize

GL_TEXTURE_BLUE_SIZE

pub fn level_alpha_size(&self, level: u32) -> usize

GL_TEXTURE_ALPHA_SIZE

pub fn depth_stencil_texture_mode(&self) -> u32

GL_DEPTH_STENCIL_TEXTURE_MODE

pub fn mag_filter(&self) -> u32

GL_TEXTURE_MAG_FILTER

pub fn min_filter(&self) -> u32

GL_TEXTURE_MIN_FILTER

pub fn min_lod(&self) -> i32

GL_TEXTURE_MIN_LOD

pub fn max_lod(&self) -> i32

GL_TEXTURE_MAX_LOD

pub fn base_level(&self) -> i32

GL_TEXTURE_BASE_LEVEL

pub fn max_level(&self) -> i32

GL_TEXTURE_MAX_LEVEL

pub fn swizzle_r(&self) -> Component

GL_TEXTURE_SWIZZLE_R

pub fn swizzle_g(&self) -> Component

GL_TEXTURE_SWIZZLE_G

pub fn swizzle_b(&self) -> Component

GL_TEXTURE_SWIZZLE_B

pub fn swizzle_a(&self) -> Component

GL_TEXTURE_SWIZZLE_A

pub fn swizzles(&self) -> Swizzles

GL_TEXTURE_SWIZZLE_RGBA

pub fn wrap_s(&self) -> u32

GL_TEXTURE_WRAP_S

pub fn wrap_t(&self) -> u32

GL_TEXTURE_WRAP_T

pub fn wrap_r(&self) -> u32

GL_TEXTURE_WRAP_R

pub fn border_color(&self) -> [f32; 4]

GL_TEXTURE_BORDER_COLOR

pub fn compare_mode(&self) -> u32

GL_TEXTURE_COMPARE_MODE

pub fn compare_func(&self) -> u32

GL_TEXTURE_COMPARE_FUNC

pub fn image_format_compatibility_type(&self) -> u32

GL_IMAGE_FORMAT_COMPATIBILITY_TYPE

pub unsafe fn set_parameteri(&mut self, parameter: u32, value: i32)

pub unsafe fn set_parameterf(&mut self, parameter: u32, value: f32)

pub unsafe fn get_level_parameteriv(&self, parameter: u32, level: u32) -> i32

pub unsafe fn get_parameteri(&self, parameter: u32) -> i32

pub unsafe fn get_parameterf(&self, parameter: u32) -> f32

pub unsafe fn get_parameterfv(
    &self,
    parameter: u32,
    len: usize
) -> Vec<f32, Global>

pub fn generate_mipmaps(&self)

glGenerateMipmaps

pub fn format(&self) -> Format

Returns the texture format

pub fn texture_sampler(&'a self, sampler: &'a Sampler) -> TextureSampler<'a>

Trait Implementations

impl<T> AsUniform<Texture> for T where
    T: Borrow<Texture>, 

pub fn as_uniform(&self) -> UniformValue

impl<'a> BorrowColorAttach for &'a Texture

type ColorAttach = Texture

pub fn borrow_color_attachment(&self) -> &Texture

impl<'a> BorrowDepthAttach for &'a Texture

type DepthAttach = Texture

pub fn borrow_depth_attachment(&self) -> &Texture

impl ColorAttach for Texture

pub unsafe fn color_attach(
    &self,
    framebuffer: &FrameBuffer,
    target: u32,
    attachment: u32
)

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn samples(&self) -> u32

pub fn attachment_id(&self) -> ColorAttachmentId

impl Debug for Texture

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

Formats the value using the given formatter.

impl DepthAttach for Texture

pub unsafe fn depth_attach(
    &self,
    framebuffer: &FrameBuffer,
    target: u32,
    attachment: u32
)

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn samples(&self) -> u32

pub fn attachment_id(&self) -> DepthAttachmentId

impl Drop for Texture

pub fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Texture> for Texture

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<'a> Render2d for &'a Texture

type Material = BasicMaterial<&'a Texture>

pub fn default_material(&'b self) -> BasicMaterial<&'a Texture>

pub fn render_with_material<R, M>(
    &self,
    gl: &Renderer<'_, R>,
    pos: &Point<f32, U2>,
    material: &M
) where
    M: Material,
    R: RenderSurface, 

pub fn render_size_with_material<R, M>(
    &self,
    gl: &Renderer<'_, R>,
    pos: &Point<f32, U2>,
    size: &Matrix<f32, U2, U1, <DefaultAllocator as Allocator<f32, U2, U1>>::Buffer>,
    material: &M
) where
    M: Material,
    R: RenderSurface, 

pub fn render<R>(&self, renderer: &Renderer<'_, R>, pos: &Point<f32, U2>) where
    R: RenderSurface, 

pub fn render_size<R>(
    &self,
    renderer: &Renderer<'_, R>,
    pos: &Point<f32, U2>,
    size: &Matrix<f32, U2, U1, <DefaultAllocator as Allocator<f32, U2, U1>>::Buffer>
) where
    R: RenderSurface, 

impl<'a> TextureUniformValue for &'a Texture

pub fn as_texture_uniform(&self, binding: u32) -> UniformValue

impl TextureUniformValue for Texture

pub fn as_texture_uniform(&self, binding: u32) -> UniformValue

impl Eq for Texture