Struct TextureDataRefMut

pub struct TextureDataRefMut<'a> { /* private fields */ }

A special reference holder that provides mutable access to content of the texture and automatically calculates hash of the data in its destructor.

Implementations

impl TextureDataRefMut<'_>

pub fn data_mut(&mut self) -> &mut [u8]

Returns mutable reference to the data of the texture.

pub fn data_mut_of_type<T>(&mut self) -> Option<&mut [T]>

Tries to cast the internal data buffer to the given type. Type casting will succeed only if the the size of the type T is equal with the size of the pixel. WARNING: While this function is safe, there’s no guarantee that the actual type-casted data will match the layout of your data structure. For example, you could have a pixel of type RG16, where each pixel consumes 2 bytes (4 in total) and cast it to the structure struct Rgba8 { r: u8, g: u8, b: u8, a: u8 } which is safe in terms of memory access (both are 4 bytes total), but not ok in terms of actual data. Be careful when using the method.

Methods from Deref<Target = Texture>

pub const KIND: &'static str = "kind"

pub const BYTES: &'static str = "bytes"

pub const PIXEL_KIND: &'static str = "pixel_kind"

pub const MINIFICATION_FILTER: &'static str = "minification_filter"

pub const MAGNIFICATION_FILTER: &'static str = "magnification_filter"

pub const S_WRAP_MODE: &'static str = "s_wrap_mode"

pub const T_WRAP_MODE: &'static str = "t_wrap_mode"

pub const R_WRAP_MODE: &'static str = "r_wrap_mode"

pub const BASE_LEVEL: &'static str = "base_level"

pub const MAX_LEVEL: &'static str = "max_level"

pub const MIN_LOD: &'static str = "min_lod"

pub const MAX_LOD: &'static str = "max_lod"

pub const LOD_BIAS: &'static str = "lod_bias"

pub const MIP_COUNT: &'static str = "mip_count"

pub const ANISOTROPY: &'static str = "anisotropy"

pub const MODIFICATIONS_COUNTER: &'static str = "modifications_counter"

pub const IS_RENDER_TARGET: &'static str = "is_render_target"

pub fn set_minification_filter(&mut self, filter: TextureMinificationFilter)

Sets new minification filter. It is used when texture becomes smaller.

pub fn minification_filter(&self) -> TextureMinificationFilter

Returns current minification filter.

pub fn set_magnification_filter(&mut self, filter: TextureMagnificationFilter)

Sets new magnification filter. It is used when texture is “stretching”.

pub fn magnification_filter(&self) -> TextureMagnificationFilter

Returns current magnification filter.

pub fn set_s_wrap_mode(&mut self, s_wrap_mode: TextureWrapMode)

Sets new S coordinate wrap mode.

pub fn s_wrap_mode(&self) -> TextureWrapMode

Returns current S coordinate wrap mode.

pub fn set_t_wrap_mode(&mut self, t_wrap_mode: TextureWrapMode)

Sets new T coordinate wrap mode.

pub fn t_wrap_mode(&self) -> TextureWrapMode

Returns current T coordinate wrap mode.

pub fn set_r_wrap_mode(&mut self, r_wrap_mode: TextureWrapMode)

Sets new R coordinate wrap mode.

pub fn r_wrap_mode(&self) -> TextureWrapMode

Returns current T coordinate wrap mode.

pub fn mip_count(&self) -> u32

Returns total mip count.

pub fn kind(&self) -> TextureKind

Returns texture kind.

pub fn modifications_count(&self) -> u64

Returns total amount of modifications done on the texture.

pub fn calculate_data_hash(&self) -> u64

Calculates current data hash.

pub fn pixel_kind(&self) -> TexturePixelKind

Returns current pixel kind.

pub fn base_level(&self) -> usize

Returns the index of the lowest defined mipmap level.

pub fn set_base_level(&mut self, base_level: usize)

Specifies the index of the lowest defined mipmap level. Keep in mind, that the texture data should provide the actual mip map level defined by the provided value, otherwise the rendering will be incorrect (probably just black on majority of implementations) and glitchy.

pub fn max_level(&self) -> usize

Returns the index of the highest defined mipmap level.

pub fn set_max_level(&mut self, max_level: usize)

Sets the index of the highest defined mipmap level. Keep in mind, that the texture data should provide the actual mip map level defined by the provided value, otherwise the rendering will be incorrect (probably just black on majority of implementations) and glitchy.

pub fn min_lod(&self) -> f32

Returns the minimum level-of-detail parameter. See Self::set_min_lod for more info.

pub fn set_min_lod(&mut self, min_lod: f32)

Sets the minimum level-of-detail parameter. This floating-point value limits the selection of highest resolution mipmap (lowest mipmap level). The initial value is -1000.0.

pub fn max_lod(&self) -> f32

Returns the maximum level-of-detail parameter. See Self::set_max_lod for more info.

pub fn set_max_lod(&mut self, max_lod: f32)

Sets the maximum level-of-detail parameter. This floating-point value limits the selection of the lowest resolution mipmap (highest mipmap level). The initial value is 1000.

pub fn lod_bias(&self) -> f32

Returns a fixed bias value that is to be added to the level-of-detail parameter for the texture before texture sampling. See Self::set_lod_bias for more info.

pub fn set_lod_bias(&mut self, lod_bias: f32)

Specifies a fixed bias value that is to be added to the level-of-detail parameter for the texture before texture sampling. The specified value is added to the shader-supplied bias value (if any) and subsequently clamped into the implementation-defined range −bias_max..bias_max, where bias_max is the value that can be fetched from the current graphics server. The initial value is 0.0.

pub fn data(&self) -> &[u8]

Returns current data as immutable slice.

pub fn data_of_type<T>(&self) -> Option<&[T]>

Tries to cast the internal data buffer to the given type. Type casting will succeed only if the the size of the type T is equal with the size of the pixel.

Important notes

While this function is safe, there’s no guarantee that the actual type-casted data will match the layout of your data structure. For example, you could have a pixel of type RG16, where each pixel consumes 2 bytes (4 in total) and cast it to the structure struct Rgba8 { r: u8, g: u8, b: u8, a: u8 } which is safe in terms of memory access (both are 4 bytes total), but not ok in terms of actual data. Be careful when using this method.

Keep in mind, that this method will return a reference to all data in the texture, including all mip levels. If you need to get typed data from specific mip level use Self::mip_level_data_of_type.

pub fn mip_level_data(&self, mip: usize) -> &[u8]

Returns data of the given mip level.

pub fn mip_level_data_of_type<T>(&self, mip: usize) -> Option<&[T]>

Tries to cast the specific mip level data of the internal data buffer to the given type. Type casting will succeed only if the the size of the type T is equal with the size of the pixel.

Important notes

While this function is safe, there’s no guarantee that the actual type-casted data will match the layout of your data structure. For example, you could have a pixel of type RG16, where each pixel consumes 2 bytes (4 in total) and cast it to the structure struct Rgba8 { r: u8, g: u8, b: u8, a: u8 } which is safe in terms of memory access (both are 4 bytes total), but not ok in terms of actual data. Be careful when using this method.

pub fn is_render_target(&self) -> bool

Returns true if the texture is used as render target.

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

Max samples for anisotropic filtering. Default value is 16.0 (max). However real value passed to GPU will be clamped to maximum supported by current GPU. To disable anisotropic filtering set this to 1.0. Typical values are 2.0, 4.0, 8.0, 16.0.

pub fn anisotropy_level(&self) -> f32

Returns current anisotropy level.

pub fn modify(&mut self) -> TextureDataRefMut<'_>

Returns a special reference holder that provides mutable access to content of the texture and automatically calculates hash of the data in its destructor.

Trait Implementations

impl DerefMut for TextureDataRefMut<'_>

fn deref_mut(&mut self) -> &mut <TextureDataRefMut<'_> as Deref>::Target

Mutably dereferences the value.

impl Drop for TextureDataRefMut<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Deref for TextureDataRefMut<'_>

type Target = Texture

The resulting type after dereferencing.

fn deref(&self) -> &<TextureDataRefMut<'_> as Deref>::Target

Dereferences the value.