Clean-up CheckFeatureSupport.

* Renames ALLOCATOR_FEATURE to FEATURE
* Adds documentation to FEATURE_RESOURCE_SUBALLOCATION_SUPPORT constant.

Author: bbernhar

src/gpgmm/d3d12/ResourceAllocatorD3D12.cpp

@@ -1242,12 +1242,12 @@ namespace gpgmm::d3d12 {
         return mResidencyManager != nullptr && !mIsAlwaysInBudget;
     }
 
-    HRESULT ResourceAllocator::CheckFeatureSupport(ALLOCATOR_FEATURE feature,
+    HRESULT ResourceAllocator::CheckFeatureSupport(FEATURE feature,
                                                    void* pFeatureSupportData,
-                                                   uint32_t featureSupportDataSize) {
+                                                   uint32_t featureSupportDataSize) const {
         switch (feature) {
-            case RESOURCE_ALLOCATOR_FEATURE_SUBALLOCATION_SUPPORT: {
-                ALLOCATOR_FEATURE_DATA_SUBALLOCATION_SUPPORT data = {};
+            case FEATURE_RESOURCE_SUBALLOCATION_SUPPORT: {
+                FEATURE_DATA_RESOURCE_SUBALLOCATION_SUPPORT data = {};
                 if (featureSupportDataSize != sizeof(data)) {
                     return E_INVALIDARG;
                 }

src/gpgmm/d3d12/ResourceAllocatorD3D12.h

@@ -354,26 +354,33 @@ namespace gpgmm::d3d12 {
         std::string DebugName;
     };
 
-    /** \struct ALLOCATOR_FEATURE_DATA_SUBALLOCATION_SUPPORT
+    /** \struct FEATURE_DATA_RESOURCE_SUBALLOCATION_SUPPORT
 
     Details the resource allocator limitations, including if sharing resources between command
     queues is coherent.
     */
-    struct ALLOCATOR_FEATURE_DATA_SUBALLOCATION_SUPPORT {
+    struct FEATURE_DATA_RESOURCE_SUBALLOCATION_SUPPORT {
         /** \brief Describes multi-queue resource access behavior.
 
         For example, if two allocations belong to the same resource where each allocation is
         referenced with a different command-queue, will accessing one stomp over the other. D3D12
-        does not guarentee such behavior is safe but it is defined per GPU vendor.
+        does not guarentee such behavior is safe but is it well-defined behavior based on the GPU
+        vendor.
         */
         bool IsResourceAccessAlwaysCoherent;
     };
 
-    /** \enum ALLOCATOR_FEATURE
-    Additional capabilities featured by resource allocators.
+    /** \enum FEATURE
+
+    Defines constants that specify a resource allocator feature to query about. When you
+    want to query for the level to which an allocator supports a feature, pass one of these values
+    to ResourceAllocator::CheckFeatureSupport.
     */
-    enum ALLOCATOR_FEATURE {
-        RESOURCE_ALLOCATOR_FEATURE_SUBALLOCATION_SUPPORT,
+    enum FEATURE {
+        /** \brief Indicates a query for the level of support for sub-allocated resources. The
+        corresponding data structure for this value is FEATURE_DATA_RESOURCE_SUBALLOCATION_SUPPORT
+        */
+        FEATURE_RESOURCE_SUBALLOCATION_SUPPORT,
     };
 
     using RESOURCE_ALLOCATOR_INFO = MemoryAllocatorInfo;
@@ -507,21 +514,21 @@ namespace gpgmm::d3d12 {
 
         /** \brief Gets information about the features that are supported by the resource allocator.
 
-        @param feature A constant from the ALLOCATOR_FEATURE enumeration describing the feature(s)
+        @param feature A constant from the FEATURE enumeration describing the feature(s)
         that you want to query for support.
         @param pFeatureSupportData A pointer to the data structure that corresponds to the value of
         the feature parameter. To determine the corresponding data structure for each constant, see
-        ALLOCATOR_FEATURE.
+        FEATURE.
         @param featureSupportDataSize The sie of the structure pointed by the pFeatureSupportData
         parameter.
 
         \return Returns S_OK if successful. Returns E_INVALIDARG if unsupported data type is passed
         to pFeatureSupportData or if a size mismatch is detected for the featureSupportDataSize
         parameter.
         */
-        HRESULT CheckFeatureSupport(ALLOCATOR_FEATURE feature,
+        HRESULT CheckFeatureSupport(FEATURE feature,
                                     void* pFeatureSupportData,
-                                    uint32_t featureSupportDataSize);
+                                    uint32_t featureSupportDataSize) const;
 
       private:
         friend BufferAllocator;

src/tests/end2end/D3D12ResourceAllocatorTests.cpp

@@ -1387,20 +1387,20 @@ TEST_F(D3D12ResourceAllocatorTests, CheckFeatureSupport) {
             uint64_t bigItem;
         } WrongData = {};
 
-        ASSERT_FAILED(resourceAllocator->CheckFeatureSupport(
-            RESOURCE_ALLOCATOR_FEATURE_SUBALLOCATION_SUPPORT, &WrongData, sizeof(WrongData)));
+        ASSERT_FAILED(resourceAllocator->CheckFeatureSupport(FEATURE_RESOURCE_SUBALLOCATION_SUPPORT,
+                                                             &WrongData, sizeof(WrongData)));
     }
 
     // Request information with no data.
     {
-        ASSERT_FAILED(resourceAllocator->CheckFeatureSupport(
-            RESOURCE_ALLOCATOR_FEATURE_SUBALLOCATION_SUPPORT, nullptr, 0));
+        ASSERT_FAILED(resourceAllocator->CheckFeatureSupport(FEATURE_RESOURCE_SUBALLOCATION_SUPPORT,
+                                                             nullptr, 0));
     }
 
     // Request information with valid data size.
     {
-        ALLOCATOR_FEATURE_DATA_SUBALLOCATION_SUPPORT data = {};
+        FEATURE_DATA_RESOURCE_SUBALLOCATION_SUPPORT data = {};
         ASSERT_SUCCEEDED(resourceAllocator->CheckFeatureSupport(
-            RESOURCE_ALLOCATOR_FEATURE_SUBALLOCATION_SUPPORT, &data, sizeof(data)));
+            FEATURE_RESOURCE_SUBALLOCATION_SUPPORT, &data, sizeof(data)));
     }
 }