Struct Texture

pub struct Texture {
    pub texture: Arc<Texture>,
    pub view: Arc<TextureView>,
    pub sampler: Arc<Sampler>,
    /* private fields */
}

A texture living on the GPU.

Fields

texture: Arc<Texture>

view: Arc<TextureView>

sampler: Arc<Sampler>

Implementations

impl Texture

pub const DEPTH_FORMAT: TextureFormat = wgpu::TextureFormat::Depth32Float

pub const HDR_TEXTURE_FORMAT: TextureFormat = wgpu::TextureFormat::Rgba16Float

pub fn id(&self) -> usize

Returns the id of this texture.

The id is a monotonically increasing count of all textures created.

This can be used to determine if a texture has been replaced by another, which can be used, for example, to invalidate a [wgpu::BindGroup].

pub fn width(&self) -> u32

pub fn height(&self) -> u32

pub fn size(&self) -> UVec2

pub fn new_cubemap_texture( runtime: impl AsRef<WgpuRuntime>, label: Option<impl AsRef<str>>, texture_size: u32, face_textures: &[Texture], image_format: TextureFormat, mip_levels: u32, ) -> Self

Create a cubemap texture from 6 faces.

pub fn new_with( runtime: impl AsRef<WgpuRuntime>, label: Option<&str>, usage: Option<TextureUsages>, sampler: Option<Sampler>, format: TextureFormat, color_channels: u32, color_channel_bytes: u32, width: u32, height: u32, mip_level_count: u32, data: &[u8], ) -> Self

Create a new texture.

pub fn new( runtime: impl AsRef<WgpuRuntime>, label: Option<&str>, usage: Option<TextureUsages>, color_channels: u32, width: u32, height: u32, data: &[u8], ) -> Self

Create a new texture.

This defaults the format to Rgba8UnormSrgb and assumes a pixel is 1 byte per channel.

pub fn from_image_bytes( runtime: impl AsRef<WgpuRuntime>, bytes: &[u8], label: &str, ) -> Result<Self, TextureError>

pub fn from_dynamic_image( runtime: impl AsRef<WgpuRuntime>, dyn_img: DynamicImage, label: Option<&str>, usage: Option<TextureUsages>, mip_level_count: u32, ) -> Self

pub fn from_image_buffer<P>( runtime: impl AsRef<WgpuRuntime>, img: &ImageBuffer<P, Vec<u8>>, label: Option<&str>, usage: Option<TextureUsages>, mip_level_count: Option<u32>, ) -> Result<Self, TextureError>

where P: PixelWithColorType, ImageBuffer<P, Vec<u8>>: GenericImage + Deref<Target = [u8]>,

pub fn from_wgpu_tex( device: &Device, texture: impl Into<Arc<Texture>>, sampler: Option<SamplerDescriptor<'_>>, mip_level_count: Option<u32>, ) -> Self

pub fn create_depth_texture( device: &Device, width: u32, height: u32, multisample_count: u32, label: Option<&str>, ) -> Self

pub fn create_depth_texture_for_shadow_map( device: &Device, width: u32, height: u32, multisample_count: u32, label: Option<&str>, is_point_light: bool, ) -> Self

pub fn read( runtime: impl AsRef<WgpuRuntime>, texture: &Texture, width: usize, height: usize, channels: usize, subpixel_bytes: usize, ) -> CopiedTextureBuffer

Read the texture from the GPU.

To read the texture you must provide the width, height, the number of color/alpha channels and the number of bytes in the underlying subpixel type (usually u8=1, u16=2 or f32=4).

pub async fn read_hdr_image( &self, runtime: impl AsRef<WgpuRuntime>, ) -> Result<Rgba32FImage, TextureError>

pub fn generate_mips( &mut self, runtime: impl AsRef<WgpuRuntime>, _label: Option<&str>, mip_levels: u32, ) -> Vec<Self>

Generate mipmap_levels - 1 mipmaps for the given texture.

Note

Ensure that self only has one mip level. If not it will try to sample from an empty mip.

pub fn create_hdr_texture( device: &Device, width: u32, height: u32, multisample_count: u32, ) -> Texture

Create a new HDR texture.

Trait Implementations

impl Clone for Texture

fn clone(&self) -> Texture

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Texture

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

Formats the value using the given formatter.