From 5bd3fdc11a15dc59a659b59e8ed4d801cfaa3eac Mon Sep 17 00:00:00 2001
From: Philip Rebohle <philip.rebohle@tu-dortmund.de>
Date: Wed, 29 Nov 2017 08:28:45 +0100
Subject: [PATCH] [dxvk] Added documentation to image view and image create
 info structs

---
 src/dxvk/dxvk_image.h | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/src/dxvk/dxvk_image.h b/src/dxvk/dxvk_image.h
index 87746beb..cd216407 100644
--- a/src/dxvk/dxvk_image.h
+++ b/src/dxvk/dxvk_image.h
@@ -5,22 +5,60 @@
 
 namespace dxvk {
   
+  /**
+   * \brief Image create info
+   * 
+   * The properties of an image that are
+   * passed to \ref DxvkDevice::createImage
+   */
   struct DxvkImageCreateInfo {
+    /// Image dimension
     VkImageType type;
+    
+    /// Pixel format
     VkFormat format;
+    
+    /// Sample count for MSAA
     VkSampleCountFlagBits sampleCount;
+    
+    /// Image size, in texels
     VkExtent3D extent;
+    
+    /// Number of image array layers
     uint32_t numLayers;
+    
+    /// Number of mip levels
     uint32_t mipLevels;
+    
+    /// Image usage flags
     VkImageUsageFlags usage;
+    
+    /// Pipeline stages that can access
+    /// the contents of the image
     VkPipelineStageFlags stages;
+    
+    /// Allowed access pattern
     VkAccessFlags access;
+    
+    /// Image tiling mode
     VkImageTiling tiling;
   };
   
+  
+  /**
+   * \brief Image create info
+   * 
+   * The properties of an image view that are
+   * passed to \ref DxvkDevice::createImageView
+   */
   struct DxvkImageViewCreateInfo {
+    /// Image view dimension
     VkImageViewType type;
+    
+    /// Pixel format
     VkFormat format;
+    
+    /// Subresources to use in the view
     VkImageAspectFlags aspect;
     uint32_t minLevel;
     uint32_t numLevels;