Merge pull request #39 from lambda-sh/vmarcella/refactoring-and-testing

Code cleanup & adding tests

Author: vmarcella

.github/workflows/compile_lambda_rs.yml

@@ -47,7 +47,7 @@ jobs:
           rustup default ${{ matrix.rustup-toolchain }}
 
       - name: Build Lambda & other default workspace members.
-        run: cargo build
+        run: cargo test --all
 
       - uses: actions/setup-ruby@v1
       - name: Send Webhook Notification for build status.

Cargo.lock

@@ -9,5 +9,6 @@ members = [
 
 default-members = [
     "lambda",
+    "crates/lambda-platform",
     "tools/lambda_rs_demo"
 ]

Cargo.toml

@@ -20,6 +20,9 @@ gfx-backend-vulkan = { version="=0.9.0", optional = true }
 gfx-backend-dx11 = { version="=0.9.0", optional = true }
 gfx-backend-dx12 = { version="=0.9.0", optional = true }
 
+[dev-dependencies]
+mockall = "=0.11.2"
+
 [features]
 default=["shaderc/build-from-source"]
 detect-platform=[]

crates/lambda-platform/Cargo.toml

@@ -1,3 +1,6 @@
+//! GPU API exports to set the platforms primary rendering API for rendering
+//! implementations to use.
+
 cfg_if::cfg_if! {
   if #[cfg(feature = "with-gl")] {
     pub use gfx_backend_gl as RenderingAPI;

crates/lambda-platform/src/gfx/api.rs

@@ -1,21 +1,6 @@
-pub mod internal {
-  pub use gfx_hal::{
-    pso::{
-      EntryPoint,
-      InputAssemblerDesc,
-      Primitive,
-      PrimitiveAssemblerDesc,
-    },
-    Backend,
-  };
+//! Primitive assembly for the graphics pipeline.
 
-  #[inline]
-  pub fn into_primitive_assembler<'shader, RenderBackend: Backend>(
-    primitive_assembler: super::PrimitiveAssembler<'shader, RenderBackend>,
-  ) -> PrimitiveAssemblerDesc<'shader, RenderBackend> {
-    return primitive_assembler.primitive_assembler;
-  }
-}
+use gfx_hal::pso;
 
 /// PrimitiveAssemblerBuilder for preparing PrimitiveAssemblers to use in the
 /// lambda-platform Rendering pipeline.
@@ -32,14 +17,13 @@ impl PrimitiveAssemblerBuilder {
     self,
     vertex_shader: &'shader super::shader::ShaderModule<RenderBackend>,
   ) -> PrimitiveAssembler<'shader, RenderBackend> {
-    // TODO(vmarcella): The builder should expose more fields for the
-    let primitive_assembler = internal::PrimitiveAssemblerDesc::Vertex {
+    let primitive_assembler = pso::PrimitiveAssemblerDesc::Vertex {
       buffers: &[],
       attributes: &[],
-      input_assembler: internal::InputAssemblerDesc::new(
-        internal::Primitive::TriangleList,
+      input_assembler: pso::InputAssemblerDesc::new(
+        pso::Primitive::TriangleList,
       ),
-      vertex: internal::EntryPoint {
+      vertex: pso::EntryPoint {
         entry: vertex_shader.entry(),
         module: super::internal::module_for(vertex_shader),
         specialization: vertex_shader.specializations().clone(),
@@ -57,11 +41,22 @@ impl PrimitiveAssemblerBuilder {
 /// PrimitiveAssembler for used for describing how Vertex Shaders should
 /// construct primitives. Each constructed Primitive Assembler should be alive
 /// for as long as the shader module that created it is.
-pub struct PrimitiveAssembler<'shader, RenderBackend: internal::Backend> {
-  primitive_assembler: internal::PrimitiveAssemblerDesc<'shader, RenderBackend>,
+pub struct PrimitiveAssembler<'shader, RenderBackend: gfx_hal::Backend> {
+  primitive_assembler: pso::PrimitiveAssemblerDesc<'shader, RenderBackend>,
 }
 
-impl<'shader, RenderBackend: internal::Backend>
+impl<'shader, RenderBackend: gfx_hal::Backend>
   PrimitiveAssembler<'shader, RenderBackend>
 {
 }
+
+/// Internal functions for the primitive assembler. User applications most
+/// likely should not use these functions directly nor should they need to.
+pub mod internal {
+  #[inline]
+  pub fn into_primitive_assembler<'shader, RenderBackend: gfx_hal::Backend>(
+    primitive_assembler: super::PrimitiveAssembler<'shader, RenderBackend>,
+  ) -> gfx_hal::pso::PrimitiveAssemblerDesc<'shader, RenderBackend> {
+    return primitive_assembler.primitive_assembler;
+  }
+}

crates/lambda-platform/src/gfx/assembler.rs

@@ -1,3 +1,7 @@
+//! GPU fence & semaphore implementations for rendering synchronizations. These
+//! implementations built on top of gfx-hal and are used by the lambda-platform
+//! rendering implementations to synchronize GPU operations.
+
 use gfx_hal::device::Device;
 
 pub struct RenderSemaphoreBuilder {}
@@ -7,6 +11,8 @@ impl RenderSemaphoreBuilder {
     return Self {};
   }
 
+  /// Builds a new render semaphore using the provided GPU. This semaphore can
+  /// only be used with the GPU that it was created with.
   pub fn build<RenderBackend: gfx_hal::Backend>(
     self,
     gpu: &mut super::gpu::Gpu<RenderBackend>,
@@ -18,6 +24,7 @@ impl RenderSemaphoreBuilder {
     return RenderSemaphore { semaphore };
   }
 }
+
 pub struct RenderSemaphore<RenderBackend: gfx_hal::Backend> {
   semaphore: RenderBackend::Semaphore,
 }
@@ -36,6 +43,8 @@ pub struct RenderSubmissionFenceBuilder {
 }
 
 impl RenderSubmissionFenceBuilder {
+  /// Creates a new Render Submission Fence Builder that defaults to a 1 second
+  /// timeout for waiting on the fence.
   pub fn new() -> Self {
     return Self {
       default_render_timeout: 1_000_000_000,
@@ -49,6 +58,8 @@ impl RenderSubmissionFenceBuilder {
     return self;
   }
 
+  /// Builds a new submission fence using the provided GPU. This fence can only
+  /// be used to block operation on the GPU that created it.
   pub fn build<RenderBackend: gfx_hal::Backend>(
     self,
     gpu: &mut super::gpu::Gpu<RenderBackend>,