Struct Atlas

pub struct Atlas { /* private fields */ }

A texture atlas, used to store all the textures in a scene.

Clones of Atlas all point to the same internal data.

Implementations

impl Atlas

pub fn device(&self) -> &Device

pub fn new( slab: &SlabAllocator<WgpuRuntime>, size: Extent3d, format: Option<TextureFormat>, label: Option<&str>, usage: Option<TextureUsages>, ) -> Self

Create a new atlas.

Size must be a power of two.

Panics

Panics if size is not a power of two.

pub fn descriptor_id(&self) -> Id<AtlasDescriptor>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get_texture(&self) -> impl Deref<Target = Texture> + '_

Returns a reference to the current atlas texture array.

pub fn get_layers(&self) -> impl Deref<Target = Vec<Layer>> + '_

pub fn set_images( &self, images: &[AtlasImage], ) -> Result<Vec<AtlasTexture>, AtlasError>

Reset this atlas with all new images.

Any existing Hybrid<AtlasTexture>s will be invalidated.

pub fn get_size(&self) -> Extent3d

pub fn add_images<'a>( &self, images: impl IntoIterator<Item = &'a AtlasImage>, ) -> Result<Vec<AtlasTexture>, AtlasError>

Add the given images

pub fn add_image(&self, image: &AtlasImage) -> Result<AtlasTexture, AtlasError>

Add one image.

If you have more than one image, you should use Atlas::add_images, as every change in images causes a repacking, which might be expensive.

pub fn resize( &self, runtime: impl AsRef<WgpuRuntime>, extent: Extent3d, ) -> Result<(), AtlasError>

Resize the atlas.

This also distributes the images by size among all layers in an effort to reduce the likelyhood that packing the atlas may fail.

Errors

Errors if size has a width or height that is not a power of two, or are unequal

pub fn upkeep(&self, runtime: impl AsRef<WgpuRuntime>) -> bool

Perform upkeep on the atlas.

This removes any TextureFrames that have no references and repacks the atlas if any were removed.

Returns true if the atlas texture was recreated.

pub fn atlas_img_buffer( &self, runtime: impl AsRef<WgpuRuntime>, layer: u32, ) -> CopiedTextureBuffer

Read the atlas image from the GPU into a CopiedTextureBuffer.

This is primarily for testing.

Panics

Panics if the pixels read from the GPU cannot be read.

pub async fn atlas_img( &self, runtime: impl AsRef<WgpuRuntime>, layer: u32, ) -> RgbaImage

Read the atlas image from the GPU.

This is primarily for testing.

The resulting image will be in a linear color space.

Panics

Panics if the pixels read from the GPU cannot be converted into an RgbaImage.

pub async fn read_images( &self, runtime: impl AsRef<WgpuRuntime>, ) -> Vec<RgbaImage>

pub fn update_texture( &self, atlas_texture: &AtlasTexture, source_texture: &Texture, ) -> Result<SubmissionIndex, AtlasError>

Update the given AtlasTexture with a Texture.

This will blit the Texture into the frame of the Atlas pointed to by the AtlasTexture.

Returns a submission index that can be polled with [wgpu::Device::poll].

pub fn update_textures<'a>( &self, updates: impl IntoIterator<Item = (&'a AtlasTexture, &'a Texture)>, ) -> Result<SubmissionIndex, AtlasError>

Update the given AtlasTextures with Textures.

This will blit the Texture into the frame of the Atlas pointed to by the AtlasTexture.

Returns a submission index that can be polled with [wgpu::Device::poll].

pub fn update_images<'a>( &self, updates: impl IntoIterator<Item = (&'a AtlasTexture, impl Into<AtlasImage>)>, ) -> Result<SubmissionIndex, AtlasError>

Update the given AtlasTextures with new data.

This will blit the image data into the frame of the Atlas pointed to by the AtlasTexture.

Returns a submission index that can be polled with [wgpu::Device::poll].

pub fn update_image( &self, atlas_texture: &AtlasTexture, source_image: impl Into<AtlasImage>, ) -> Result<SubmissionIndex, AtlasError>

Update the given AtlasTextures with new data.

This will blit the image data into the frame of the Atlas pointed to by the AtlasTexture.

Returns a submission index that can be polled with [wgpu::Device::poll].

Trait Implementations

impl Clone for Atlas

fn clone(&self) -> Atlas

Returns a duplicate of the value.

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

Performs copy-assignment from source.