bringing docs up to date

src/canvas/canvas_state.rs

@@ -18,7 +18,7 @@ use vulkano::swapchain::Capabilities;
 use winit::Window;
 use vulkano::pipeline::viewport::Viewport;
 use vulkano::descriptor::descriptor::DescriptorDescTy::TexelBuffer;
-use crate::canvas::canvas_frame::{CanvasFrame, CanvasFrameTest};
+use crate::canvas::canvas_frame::{CanvasFrame};
 use std::hash::Hash;
 use vulkano::pipeline::depth_stencil::{StencilFaceFlags, DynamicStencilValue};
 use vulkano::memory::pool::PotentialDedicatedAllocation::Generic;
@@ -45,15 +45,15 @@ pub struct CanvasState {
     /// Generated during new()
     sampler: Arc<Sampler>,
 
-    // hold the image, texture, and Fonts the same was as we do CompuState
+    /// hold the image, texture, and Fonts the same was as we do CompuState
     image_buffers: Vec<Arc<CanvasImage>>,
     texture_buffers: Vec<Arc<CanvasTexture>>,
     font_buffers: Vec<Arc<CanvasFont>>,
 
-    // Compiled Graphics pipelines have a handle which self describe their position in this vector
+    /// Compiled Graphics pipelines have a handle which self describe their position in this vector
     shader_buffers: Vec<Arc<Box<dyn CompiledGraphicsPipeline>>>,
 
-    // Looks like we gotta hold onto the queue for managing textures
+    /// Looks like we gotta hold onto the queue for managing textures
     queue: Arc<Queue>,
     device: Arc<Device>,
     render_pass: Arc<dyn RenderPassAbstract + Send + Sync>,
@@ -260,6 +260,7 @@ impl CanvasState {
                                    physical: PhysicalDevice,
                                    capabilities: Capabilities) -> Option<Arc<CompiledShaderHandle>>
         where T: CompiledGraphicsPipeline {
+
         let handle = Arc::new(CompiledShaderHandle {
             handle: self.shader_buffers.len() as u32
         });
@@ -385,8 +386,8 @@ impl CanvasState {
         o
     }
 
-    /// Consume and allocated the canvas frame data to the GPU
-    pub fn allocate(&mut self, canvas_frame: CanvasFrameTest) -> CanvasFrameAllocation {
+    /// Consume and allocate the canvas frame data to the GPU
+    pub fn allocate(&mut self, canvas_frame: CanvasFrame) -> CanvasFrameAllocation {
 
         let mut colored_vertex_buffer: Vec<ColorVertex2D> = Vec::default();
         let mut textured_vertex_buffer: HashMap<Arc<CanvasTextureHandle>, Vec<TextureVertex2D>> = HashMap::new();