Merge pull request #219 from expipiplus1/joe-162-clean

Bump spec version to 1.2.162 and other things

VulkanMemoryAllocator/VulkanMemoryAllocator.cabal

@@ -4,10 +4,10 @@ cabal-version: 2.2
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 092e2d884bd8854f8d4ff976ae245ec1b5534fa63efae7f0283056bbb3f999d0
+-- hash: fcf45270da7fe44091b7dee466087cd52abed25e68532b85a04a30915dd1da94
 
 name:           VulkanMemoryAllocator
-version:        0.3.9
+version:        0.3.10
 synopsis:       Bindings to the VulkanMemoryAllocator library
 category:       Graphics
 homepage:       https://github.com/expipiplus1/vulkan#readme
@@ -65,7 +65,7 @@ library
     , bytestring
     , transformers
     , vector
-    , vulkan ==3.6.*
+    , vulkan >=3.6 && <3.8
   if flag(safe-foreign-calls)
     cpp-options: -DSAFE_FOREIGN_CALLS
   if flag(vma-ndebug)

VulkanMemoryAllocator/changelog.md

@@ -2,6 +2,10 @@
 
 ## WIP
 
+## [0.3.10] - 2020-11-24
+
+- Documentation fixes
+
 ## [0.3.9] - 2020-11-15
 
 - Derive `FiniteBits` for bitmasks

VulkanMemoryAllocator/package.yaml

@@ -1,5 +1,5 @@
 name: VulkanMemoryAllocator
-version: "0.3.9"
+version: "0.3.10"
 synopsis: Bindings to the VulkanMemoryAllocator library
 category: Graphics
 maintainer: Joe Hermaszewski <[email protected]>
@@ -20,7 +20,7 @@ library:
     src/lib.cpp
   dependencies:
     - base <5
-    - vulkan == 3.6.*
+    - vulkan >= 3.6 && < 3.8
     - bytestring
     - transformers
     - vector

cabal.project

@@ -4,3 +4,10 @@ packages:
   ./utils
   ./examples
   ./generate-new/
+
+source-repository-package
+    type: git
+    location: https://github.com/expipiplus1/brittany.git
+    tag: b80f77c36bda563665c616abbdb1eaaf35b1da1c
+
+allow-newer: strict

changelog.md

@@ -2,9 +2,18 @@
 
 ## WIP
 
+## [3.7] - 2020-11-24
+- Bump API version to v1.2.162
+  - This is a breaking change to anyone using VK_KHR_ray_tracing (which no
+    longer exists)
 - Add bracketing functions for `withRayTracingPipelinesKHR` and
   `withRayTracingPipelinesNV`
 - Add all possible storable instances for Vulkan structs
+- Remove tuples from the constructors of `ClearColorValue`
+- Unpack top level tuple in `TransformMatrixKHR`, the `matrix` record accessor
+  has been split into `matrixRow0`, `matrixRow1`, and `matrixRow2`
+- Add extension documentation to extension modules.
+- Tweak ordering of documentation in Haddocks to make it more user-friendly
 
 ## [3.6.15] - 2020-11-16
 - Bump API version to v1.2.161

examples/hlsl/Render.hs

@@ -97,7 +97,7 @@ myRecordCommandBuffer Frame {..} imageIndex = do
         { renderPass  = srRenderPass
         , framebuffer = srFramebuffers ! fromIntegral imageIndex
         , renderArea  = Rect2D { offset = zero, extent = siImageExtent }
-        , clearValues = [Color (Float32 (0.3, 0.4, 0.8, 1))]
+        , clearValues = [Color (Float32 0.3 0.4 0.8 1)]
         }
   cmdUseRenderPass' renderPassBeginInfo SUBPASS_CONTENTS_INLINE $ do
     cmdSetViewport'

examples/offscreen/Main.hs

@@ -436,7 +436,7 @@ render = do
               { renderPass  = renderPass
               , framebuffer = framebuffer
               , renderArea  = Rect2D zero (Extent2D width height)
-              , clearValues = [Color (Float32 (0.1, 0.1, 0.1, 1))]
+              , clearValues = [Color (Float32 0.1 0.1 0.1 1)]
               }
         cmdUseRenderPass commandBuffer
                          renderPassBeginInfo

examples/package.yaml

@@ -109,7 +109,7 @@ executables:
       - unliftio
       - vector
       - vulkan
-      - vulkan-utils
+      - vulkan-utils >= 0.3
 
   hlsl:
     main: Main.hs
@@ -131,7 +131,7 @@ executables:
       - unliftio
       - vector
       - vulkan
-      - vulkan-utils
+      - vulkan-utils >= 0.3
       - file-embed
       - extra
       - filepath

examples/resize/Main.hs

@@ -352,7 +352,7 @@ draw = do
                 { renderPass  = fRenderPass
                 , framebuffer = fFramebuffers imageIndex
                 , renderArea  = Rect2D zero fImageExtent
-                , clearValues = [Color (Float32 (0.1, 0.1, 0.1, 1))]
+                , clearValues = [Color (Float32 0.1 0.1 0.1 1)]
                 }
           cmdSetViewport'
             0

examples/sdl-triangle/Main.hs

@@ -152,7 +152,7 @@ createCommandBuffers dev renderPass graphicsPipeline graphicsQueueFamilyIndex fr
                   , renderArea  = Rect2D { offset = zero
                                          , extent = swapchainExtent
                                          }
-                  , clearValues = [Color (Float32 (0.1, 0.1, 0.1, 0))]
+                  , clearValues = [Color (Float32 0.1 0.1 0.1 0)]
                   }
             cmdUseRenderPass buffer renderPassBeginInfo SUBPASS_CONTENTS_INLINE
               $ do

examples/vulkan-examples.cabal

@@ -4,7 +4,7 @@ cabal-version: 2.2
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: c641a1d3b72c0ffdef54bfcca0660561a30596c0e2e2e2f46676e51ffe52da17
+-- hash: 07469fd86a282e5431bb11f41a2b513268d1238cb7897b4d75f8a5ecda9438f5
 
 name:           vulkan-examples
 version:        0.1.0.0
@@ -102,7 +102,7 @@ executable hlsl
     , unliftio
     , vector
     , vulkan
-    , vulkan-utils
+    , vulkan-utils >=0.3
   if os(windows)
     ghc-options: -optl-mconsole
   if impl(ghc < 8.10.0)
@@ -238,7 +238,7 @@ executable timeline-semaphore
     , unliftio
     , vector
     , vulkan
-    , vulkan-utils
+    , vulkan-utils >=0.3
   if os(windows)
     ghc-options: -optl-mconsole
   default-language: Haskell2010

generate-new/generate-new.cabal

@@ -4,7 +4,7 @@ cabal-version: 1.12
 --
 -- see: https://github.com/sol/hpack
 --
--- hash: 5239514d98fffcdddcdbabbf880d348e859b4eccc99e9610c0ec8a389c06b434
+-- hash: f003049e4e28f45438397824d96b59f210dce0b5135c67e24548bd9019a968f5
 
 name:           generate-new
 version:        0.0.0
@@ -61,6 +61,7 @@ library
       Render.Spec.Extends
       Render.Spec.Versions
       Render.SpecInfo
+      Render.State
       Render.Stmts
       Render.Stmts.Alloc
       Render.Stmts.Poke
@@ -91,6 +92,7 @@ library
     , ascii-progress
     , async-pool
     , base
+    , brittany
     , bytestring
     , casing
     , containers
@@ -150,6 +152,7 @@ executable vk
     , ascii-progress
     , async-pool
     , base
+    , brittany
     , bytestring
     , casing
     , containers
@@ -211,6 +214,7 @@ executable vma
     , ascii-progress
     , async-pool
     , base
+    , brittany
     , bytestring
     , casing
     , containers

generate-new/package.yaml

@@ -82,6 +82,7 @@ dependencies:
   - async-pool
   - base
   - bytestring
+  - brittany
   - casing
   - containers
   - data-default

generate-new/readme.md

@@ -91,6 +91,51 @@ The docbook documentation will be in `docs/docbook`.
 
 During development unfinished bits not to forget are listed here.
 
+### 1.2.162
+
+- [x] optionalness on VkWriteDescriptorSetAccelerationStructureKHR->pAccelerationStructures
+- [x] VkAccelerationStructureVersionKHR
+- [x] VkAccelerationStructureInstanceKHR
+- [x] VkAccelerationStructureBuildGeometryInfoKHR
+- [x] VkAccelerationStructureBuildGeometryInfoKHR->pGeometries (esp optionalness)
+- [x] VkAccelerationStructureBuildGeometryInfoKHR->ppGeometries (esp optionalness)
+  - [x] (this maps to the same name as pGeometries!)
+  - This has been removed from the Haskell bindings
+- [x] VkAccelerationStructureCreateInfoKHR->offset
+- [x] VkAccelerationStructureVersionInfoKHR->pVersionData
+- [x] vkCmdBuildAccelerationStructuresIndirectKHR,
+  - The `Ptr Word32` type has leaked through, this should be `Vector (Vector Word32)`
+  - [x] Fix this non-critical issue
+  - [ ] It's correct now, but it doesn't check the length of the array
+- [x] vkCmdBuildAccelerationStructuresKHR, vkBuildAccelerationStructuresKHR
+  - [x] This is still incorrect as one can't pass multiple
+    `AccelerationStructureBuildRangeInfoKHR`'s per
+    `AccelerationStructureBuildGeometryInfoKHR`. It's no more broken than
+    before though.
+  - [ ] Fixed, although there's no length checking
+- [x] vkGetAccelerationStructureBuildSizesKHR
+  - [ ] It's correct, but it doesn't check the length of the
+    `maxPrimitiveCount` array like it would with a sibling array of same length
+- [x] pNext is now optional, this breaks the Zero instances
+
+Optional TODOs:
+
+- [x] cmdTraceRaysKHR is not using the storable instance of StridedDeviceAddressRegionKHR
+  - same for destroyAccelerationStructureKHR not using allocation callbacks
+  - These are due to the `indirectStruct` case of the `normal` poker
+  - This is no problem, commands have to allocate structs on the stack anyway
+- [x] likewise for `pokeCStruct` of `RayTracingPipelineCreateInfoKHR{..}`
+  - This one is because we're not looking past pointers when checking for
+    direct dependents
+  - Fixed
+- [x] Documentation on bracketing functions still mentions the "first"
+  argument, this should be chagned to "last"
+- [ ] AccelerationStructureGeometryAabbsDataKHR could use a simple poke for its
+  DeviceOrHostAddressConstKHR (is this true for the union in
+  AccelerationStructureGeometryKHR too)
+- [x] Now is the time to remove the top level tuple from TransformMatrixKHR
+
+
 # VMA TODOs
 
 ## TODO