Struct kludgine::TextureCollection

pub struct TextureCollection { /* private fields */ }

A collection of multiple textures, managed as a single texture on the GPU. This type is often called an atlas.

The collection is currently fixed-size and will panic when an allocation fails. In the future, this type will dynamically grow as more textures are added to it.

In general, this type should primarly be used with similarly-sized graphics, otherwise the packing may be inefficient. For example, packing many images that are multiples of 32px wide/tall will be very efficient. Interally, this type is used for caching rendered glyphs on the GPU.

Implementations

impl TextureCollection

pub fn new( initial_size: Size<UPx>, format: TextureFormat, filter_mode: FilterMode, graphics: &Graphics<'_> ) -> Self

Returns a new atlas of the given size and format.

pub fn push_texture( &mut self, data: &[u8], data_layout: ImageDataLayout, size: Size<UPx>, graphics: &Graphics<'_> ) -> CollectedTexture

Pushes image data to a specific region of the texture.

The data format must match the format of the texture, and must be sized exactly according to the data_layout and size and format.

The returned CollectedTexture will automatically free the space it occupies when the last instance is dropped.

pub fn push_image( &mut self, image: &DynamicImage, graphics: &Graphics<'_> ) -> CollectedTexture

Pushes an image to this collection.

The returned CollectedTexture will automatically free the space it occupies when the last instance is dropped.

Panics

Currently this only supports uploading to Rgba8 formatted textures.

pub fn size(&self) -> Size<UPx>

Returns the current size of the underlying texture.

pub fn prepare_entire_colection<Unit>( &self, dest: Rect<Unit>, graphics: &Graphics<'_> ) -> PreparedGraphic<Unit>

where Unit: Unit, Vertex<Unit>: Pod,

Returns a PreparedGraphic for the entire texture.

This is primarily a debugging tool, as generally the CollectedTextures are rendered instead.

pub const fn format(&self) -> TextureFormat

Returns the format of the texture backing this collection.

Trait Implementations

impl CanRenderTo for TextureCollection

fn can_render_to(&self, kludgine: &Kludgine) -> bool

Returns true if this resource can be rendered into a graphics context for kludgine.

impl Clone for TextureCollection

fn clone(&self) -> TextureCollection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl TextureSource for TextureCollection