doc: missing docs for util module

Author: NotAPenguin0

src/util/address.rs

@@ -1,38 +1,50 @@
+//! Wrappers around device addresses
+
 use std::ffi::c_void;
 
 use ash::vk;
 
 use crate::util::to_vk::AsVulkanType;
 
+/// Either a `VkDeviceAddress` or a mutable host pointer
 #[derive(Copy, Clone)]
 #[repr(C)]
 pub enum DeviceOrHostAddress {
+    /// Device pointer
     Device(vk::DeviceAddress),
+    /// Mutable host pointer
     Host(*mut c_void),
 }
 
+/// Either a `VkDeviceAddress` or an immutable host pointer
 #[derive(Copy, Clone)]
 #[repr(C)]
 pub enum DeviceOrHostAddressConst {
+    /// Device pointer
     Device(vk::DeviceAddress),
+    /// Immutable host pointer
     Host(*const c_void),
 }
 
 impl DeviceOrHostAddress {
+    /// Create a null pointer on the device
     pub fn null_device() -> Self {
         Self::Device(vk::DeviceAddress::default())
     }
 
+    /// Create a null pointer on the host
     pub fn null_host() -> Self {
         Self::Host(std::ptr::null_mut())
     }
 }
 
 impl DeviceOrHostAddressConst {
+    /// Create a null pointer on the device
     pub fn null_device() -> Self {
         Self::Device(vk::DeviceAddress::default())
     }
 
+    /// Create a null pointer on the host
     pub fn null_host() -> Self {
         Self::Host(std::ptr::null())
     }

src/util/align.rs

@@ -1,5 +1,8 @@
+//! Utilities for aligning memory
+
 use std::ops::{Add, Rem, Sub};
 
+/// Align a size to a required alignment. Does not align the base address.
 pub fn align<T: Add<T, Output=U> + Sub<T, Output=T> + Rem<T, Output=T> + Copy, U>(value: T, alignment: T) -> U {
     let unaligned_size = value % alignment;
     let padding = alignment - unaligned_size;

src/util/byte_size.rs

@@ -1,3 +1,5 @@
+//! Utility to get the byte size of objects
+
 use std::mem::size_of;
 
 use ash::vk;

src/util/cache.rs

@@ -1,3 +1,5 @@
+//! Generic implementation of a resource cache
+
 use std::collections::{hash_map, HashMap};
 use std::hash::Hash;
 

src/util/deferred_delete.rs

@@ -1,3 +1,5 @@
+//! Deferred deletion queue
+
 #[derive(Debug)]
 struct Item<T> {
     _value: T,

src/util/mod.rs

@@ -1,3 +1,5 @@
+//! Various utilities
+
 pub mod byte_size;
 pub mod deferred_delete;
 pub mod upload;

src/util/pnext.rs

@@ -1,7 +1,10 @@
+//! Utilities for dealing with generic pNext chains
+
 use std::ffi::c_void;
 
 use ash::vk;
 
+/// A typed element in the pNext chain
 pub enum PNext {
     WriteDescriptorSetAccelerationStructure(vk::WriteDescriptorSetAccelerationStructureKHR)
 }
@@ -11,6 +14,7 @@ fn as_void_ptr<T>(value: &T) -> *const c_void {
 }
 
 impl PNext {
+    /// Get a raw pointer to insert into the Vulkan pNext chain
     pub fn as_ptr(&self) -> *const c_void {
         match self {
             PNext::WriteDescriptorSetAccelerationStructure(value) => { as_void_ptr(value) }

src/util/string.rs

@@ -1,3 +1,5 @@
+//! String utilities for dealing with FFI strings
+
 use std::ffi::{c_char, CStr, CString};
 
 /// Wraps a c string into a string, or an empty string if the provided c string was null.

src/util/to_vk.rs

@@ -1,11 +1,17 @@
+//! Utility traits to convert objects into their corresponding vulkan types
+
+/// Convert an object into a vulkan type
 pub trait IntoVulkanType {
     type Output;
 
+    /// Consume self and return a vulkan type
     fn into_vulkan(self) -> Self::Output;
 }
 
+/// Get a reference to the object, as a vulkan type
 pub trait AsVulkanType {
     type Output;
 
+    /// Return a vulkan type that lives as long as self
     fn as_vulkan(&self) -> Self::Output;
 }

src/util/transform.rs

@@ -1,3 +1,5 @@
+//! Wrapper around `VkTransformMatrixKHR` for easy usage
+
 use ash::vk;
 
 use crate::util::to_vk::IntoVulkanType;
@@ -8,6 +10,7 @@ use crate::util::to_vk::IntoVulkanType;
 pub struct TransformMatrix(vk::TransformMatrixKHR);
 
 impl TransformMatrix {
+    /// Create an identity matrix
     pub fn identity() -> Self {
         Self(vk::TransformMatrixKHR {
             matrix: [1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0],