Struct demo_vk::graphics::SpriteLayer

pub struct SpriteLayer<UserDataT: Copy + Clone + Default> { /* private fields */ }

A sprite layer contains all of the resources to render batches of Sprites.

Multiple layers can be used for batches of sprites with different perspective transforms. (a scene layer and a ui layer, for example). Additionally, layers can be used to employ unique sprite shaders.

Implementations

impl<UserDataT: Copy + Clone + Default> SpriteLayer<UserDataT>

pub fn begin_frame_commands<'a, 'b>( &'a mut self, frame: &'b Frame, ) -> Result<SpriteLayerCommands<'a, 'b, UserDataT>>

Begin rendering a layer to the frame.

pub fn reset(&mut self, frames_in_flight: &FramesInFlight) -> Result<()>

Reset the Sprite Layer’s internal resources.

This can be more efficient than destroying and recreating a new sprite layer.

Performance

This method waits for all pending frames in flight to complete.

pub unsafe fn rebuild_pipeline( &mut self, renderpass: &RenderPass, fragment_shader: Option<Arc<ShaderModule>>, ) -> Result<()>

Rebuild the graphics pipeline

Safety

Unsafe because this should only be called when the layer is not being used by the GPU. For example, after a device wait_idle or after all frames in flight have completed.

pub fn set_projection(&mut self, projection: &Matrix4<f32>)

Sets the layer’s projection matrix. This will take effect in the next Self::begin_frame_commands call.

pub fn set_user_data(&mut self, user_data: UserDataT)

Sets the layer’s user data for the frame. This will take effect in the next Self::begin_frame_commands call.

pub fn builder<'f1, 'f2, 'f3>() -> SpriteLayerBuilder<'f1, 'f2, 'f3, UserDataT>

Creates a new sprite layer for use with the provided render pass.