Struct sfml_rust::canvas::canvas_state::CanvasState

pub struct CanvasState { /* fields omitted */ }

Canvas state is used for storage of texture and image buffers in addition to vertex buffers Canvas state also contains logic for writing the stored buffers to the command_buffer

Methods

impl CanvasState

pub fn window_size_dependent_setup(
    &mut self,
    images: &[Arc<SwapchainImage<Window>>]
) -> Vec<Arc<dyn FramebufferAbstract + Send + Sync>>

This method is called once during initialization, then again whenever the window is resized

pub fn new(
    queue: Arc<Queue>,
    device: Arc<Device>,
    physical: PhysicalDevice,
    capabilities: Capabilities
) -> CanvasState

Creates a Canvas State. Which at this point is pretty empty

pub fn create_image(
    &mut self,
    dimensions: (u32, u32),
    usage: ImageUsage
) -> Arc<CanvasImageHandle>

Using the dimensions and suggested usage, load a CanvasImage and return it's handle

pub fn get_image(
    &self,
    image_handle: Arc<CanvasImageHandle>
) -> Arc<AttachmentImage>

Return the image buffer from an input image handle

pub fn load_texture(
    &mut self,
    filename: String
) -> Option<Arc<CanvasTextureHandle>>

Load a texture using it's filename from a file. Returns the handle of the loaded texture

pub fn load_shader<T: 'static>(
    &mut self,
    filename: String,
    physical: PhysicalDevice,
    capabilities: Capabilities
) -> Option<Arc<CompiledGraphicsPipelineHandle>> where
    T: CompiledGraphicsPipeline, 

Load and Compile a shader with the filename at resources/shaders Takes physical and capabilities as we don't store that in Canvas

pub fn load_font(&mut self, name: String) -> Arc<CanvasFontHandle>

Using the dimensions and suggested usage, load a CanvasImage and return it's handle

pub fn get_texture_handle(
    &self,
    texture_name: String
) -> Option<Arc<CanvasTextureHandle>>

Using the texture name, iterates through the stored textures and matches by the name

pub fn get_shader_handle(
    &self,
    shader_name: String
) -> Option<Arc<CompiledGraphicsPipelineHandle>>

Using the shader name, iterates through the stored shaders and matches by the name

pub fn get_font_handle(
    &self,
    font_name: String
) -> Option<Arc<CanvasFontHandle>>

Using the font name, iterates through the stored fonts and matches by the name

pub fn get_texture(
    &self,
    texture_handle: Arc<CanvasTextureHandle>
) -> Arc<ImmutableImage<Format>>

Using the texture handle, grab the stored texture and return the buffer

pub fn draw(&mut self, canvas_frame: CanvasFrame)

Scrape all the values from the CanvasFrame and then allocate the vertex buffers

pub fn draw_commands(
    &mut self,
    command_buffer: AutoCommandBufferBuilder,
    framebuffers: Vec<Arc<dyn FramebufferAbstract + Send + Sync>>,
    image_num: usize
) -> AutoCommandBufferBuilder

Pushes the draw commands to the command buffer. Requires the framebuffers and image number to be passed in as they are taken care of by the vkprocessor

Trait Implementations

impl Clone for CanvasState

fn clone(&self) -> CanvasState

Returns a copy of the value.

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

Performs copy-assignment from source.