Replaced AnisotropicFilteringSupported member of SamplerProperties st…

…ruct with MaxAnisotropy (API254004)

Graphics/GraphicsEngine/interface/APIInfo.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -30,7 +30,7 @@
 /// \file
 /// Diligent API information
 
-#define DILIGENT_API_VERSION 254003
+#define DILIGENT_API_VERSION 254004
 
 #include "../../../Primitives/interface/BasicTypes.h"
 

Graphics/GraphicsEngine/interface/GraphicsTypes.h

@@ -2081,8 +2081,9 @@ struct SamplerProperties
     /// Indicates if device supports border texture addressing mode
     Bool BorderSamplingModeSupported   DEFAULT_INITIALIZER(False);
 
-    /// Indicates if device supports anisotropic filtering
-    Bool AnisotropicFilteringSupported DEFAULT_INITIALIZER(False);
+    /// Maximum anisotropy level supported by the device.
+    /// If anisotropic filtering is not supported, this value is 1.
+    Uint8 MaxAnisotropy DEFAULT_INITIALIZER(1);
 
     /// Indicates if device supports MIP load bias
     Bool LODBiasSupported              DEFAULT_INITIALIZER(False);
@@ -2096,9 +2097,9 @@ struct SamplerProperties
     /// - False otherwise.
     constexpr bool operator==(const SamplerProperties& RHS) const
     {
-        return BorderSamplingModeSupported   == RHS.BorderSamplingModeSupported   &&
-               AnisotropicFilteringSupported == RHS.AnisotropicFilteringSupported &&
-               LODBiasSupported              == RHS.LODBiasSupported;
+        return BorderSamplingModeSupported == RHS.BorderSamplingModeSupported   &&
+               MaxAnisotropy               == RHS.MaxAnisotropy &&
+               LODBiasSupported            == RHS.LODBiasSupported;
     }
 #endif
 

Graphics/GraphicsEngine/src/SamplerBase.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -41,14 +41,16 @@ namespace Diligent
 
 void ValidateSamplerDesc(const SamplerDesc& Desc, const IRenderDevice* pDevice)
 {
+    const auto& DeviceInfo  = pDevice->GetDeviceInfo();
+    const auto& AdapterInfo = pDevice->GetAdapterInfo();
     if (Desc.Flags & (SAMPLER_FLAG_SUBSAMPLED | SAMPLER_FLAG_SUBSAMPLED_COARSE_RECONSTRUCTION))
     {
-        VERIFY_SAMPLER(pDevice->GetAdapterInfo().ShadingRate.CapFlags & SHADING_RATE_CAP_FLAG_SUBSAMPLED_RENDER_TARGET,
+        VERIFY_SAMPLER(AdapterInfo.ShadingRate.CapFlags & SHADING_RATE_CAP_FLAG_SUBSAMPLED_RENDER_TARGET,
                        "Subsampled sampler requires SHADING_RATE_CAP_FLAG_SUBSAMPLED_RENDER_TARGET capability.");
     }
     if (Desc.UnnormalizedCoords)
     {
-        VERIFY_SAMPLER(pDevice->GetDeviceInfo().IsVulkanDevice() || pDevice->GetDeviceInfo().IsMetalDevice(),
+        VERIFY_SAMPLER(DeviceInfo.IsVulkanDevice() || DeviceInfo.IsMetalDevice(),
                        "Unnormalized coordinates are only supported in Vulkan and Metal.");
 
         VERIFY_SAMPLER(Desc.MinFilter == Desc.MagFilter, "When UnnormalizedCoords is true, MinFilter and MagFilter must be equal.");
@@ -58,6 +60,12 @@ void ValidateSamplerDesc(const SamplerDesc& Desc, const IRenderDevice* pDevice)
         VERIFY_SAMPLER(!IsComparisonFilter(Desc.MinFilter), "When UnnormalizedCoords is true, MinFilter and MagFilter must not be comparison.");
         VERIFY_SAMPLER(!IsAnisotropicFilter(Desc.MinFilter), "When UnnormalizedCoords is true, MinFilter and MagFilter must not be anisotropic.");
     }
+    if (IsAnisotropicFilter(Desc.MinFilter))
+    {
+        VERIFY_SAMPLER(AdapterInfo.Sampler.MaxAnisotropy >= Desc.MaxAnisotropy,
+                       "MaxAnisotropy (", Uint32{Desc.MaxAnisotropy}, ") exceeds the maximum supported anisotropy (", Uint32{AdapterInfo.Sampler.MaxAnisotropy},
+                       "). Check the value of AdapterInfo.Sampler.MaxAnisotropy to make sure it is correct.");
+    }
 }
 
 } // namespace Diligent

Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp

@@ -477,9 +477,9 @@ GraphicsAdapterInfo EngineFactoryD3D11Impl::GetGraphicsAdapterInfo(void*
     // Sampler properties
     {
         auto& SamProps{AdapterInfo.Sampler};
-        SamProps.BorderSamplingModeSupported   = True;
-        SamProps.AnisotropicFilteringSupported = True;
-        SamProps.LODBiasSupported              = True;
+        SamProps.BorderSamplingModeSupported = True;
+        SamProps.MaxAnisotropy               = D3D11_DEFAULT_MAX_ANISOTROPY;
+        SamProps.LODBiasSupported            = True;
         ASSERT_SIZEOF(SamProps, 3, "Did you add a new member to SamplerProperites? Please initialize it here.");
     }
 

Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp

@@ -1032,9 +1032,9 @@ GraphicsAdapterInfo EngineFactoryD3D12Impl::GetGraphicsAdapterInfo(void*
     {
 
         auto& SamProps{AdapterInfo.Sampler};
-        SamProps.BorderSamplingModeSupported   = True;
-        SamProps.AnisotropicFilteringSupported = True;
-        SamProps.LODBiasSupported              = True;
+        SamProps.BorderSamplingModeSupported = True;
+        SamProps.MaxAnisotropy               = D3D12_DEFAULT_MAX_ANISOTROPY;
+        SamProps.LODBiasSupported            = True;
         ASSERT_SIZEOF(SamProps, 3, "Did you add a new member to SamplerProperites? Please initialize it here.");
     }
 

Graphics/GraphicsEngineOpenGL/include/GLStubsAndroid.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -247,7 +247,11 @@
 #endif
 
 #ifndef GL_TEXTURE_MAX_ANISOTROPY_EXT
-#   define GL_TEXTURE_MAX_ANISOTROPY_EXT 0
+#   define GL_TEXTURE_MAX_ANISOTROPY_EXT 0x84FE
+#endif
+
+#ifndef GL_MAX_TEXTURE_MAX_ANISOTROPY
+#   define GL_MAX_TEXTURE_MAX_ANISOTROPY 0x84FF
 #endif
 
 #ifndef GL_TEXTURE_BORDER_COLOR

Graphics/GraphicsEngineOpenGL/include/GLStubsEmscripten.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -290,7 +290,11 @@
 #endif
 
 #ifndef GL_TEXTURE_MAX_ANISOTROPY_EXT
-#    define GL_TEXTURE_MAX_ANISOTROPY_EXT 0
+#    define GL_TEXTURE_MAX_ANISOTROPY_EXT 0x84FE
+#endif
+
+#ifndef GL_MAX_TEXTURE_MAX_ANISOTROPY
+#    define GL_MAX_TEXTURE_MAX_ANISOTROPY 0x84FF
 #endif
 
 #ifndef GL_TEXTURE_BORDER_COLOR

Graphics/GraphicsEngineOpenGL/include/GLStubsIOS.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -555,6 +555,15 @@
 #endif
 
 
+#ifndef GL_TEXTURE_MAX_ANISOTROPY_EXT
+#    define GL_TEXTURE_MAX_ANISOTROPY_EXT 0x84FE
+#endif
+
+#ifndef GL_MAX_TEXTURE_MAX_ANISOTROPY
+#    define GL_MAX_TEXTURE_MAX_ANISOTROPY 0x84FF
+#endif
+
+
 #ifndef GL_DOUBLE
 #    define GL_DOUBLE 0x140A
 #endif

Graphics/GraphicsEngineOpenGL/src/RenderDeviceGLImpl.cpp

@@ -854,9 +854,16 @@ void RenderDeviceGLImpl::InitAdapterInfo()
             TexProps.TextureView2DOn3DSupported = TexProps.TextureViewSupported;
             ASSERT_SIZEOF(TexProps, 32, "Did you add a new member to TextureProperites? Please initialize it here.");
 
-            SamProps.BorderSamplingModeSupported   = True;
-            SamProps.AnisotropicFilteringSupported = IsGL46OrAbove || CheckExtension("GL_ARB_texture_filter_anisotropic");
-            SamProps.LODBiasSupported              = True;
+            SamProps.BorderSamplingModeSupported = True;
+            if (IsGL46OrAbove || CheckExtension("GL_ARB_texture_filter_anisotropic"))
+            {
+                GLint MaxAnisotropy = 0;
+                glGetIntegerv(GL_MAX_TEXTURE_MAX_ANISOTROPY, &MaxAnisotropy);
+                CHECK_GL_ERROR("glGetIntegerv(GL_MAX_TEXTURE_MAX_ANISOTROPY)");
+                SamProps.MaxAnisotropy = static_cast<Uint8>(MaxAnisotropy);
+            }
+
+            SamProps.LODBiasSupported = True;
             ASSERT_SIZEOF(SamProps, 3, "Did you add a new member to SamplerProperites? Please initialize it here.");
 
             m_GLCaps.FramebufferSRGB  = IsGL40OrAbove || CheckExtension("GL_ARB_framebuffer_sRGB");
@@ -925,9 +932,15 @@ void RenderDeviceGLImpl::InitAdapterInfo()
             TexProps.TextureView2DOn3DSupported = TexProps.TextureViewSupported;
             ASSERT_SIZEOF(TexProps, 32, "Did you add a new member to TextureProperites? Please initialize it here.");
 
-            SamProps.BorderSamplingModeSupported   = GL_TEXTURE_BORDER_COLOR && (IsGLES32OrAbove || strstr(Extensions, "texture_border_clamp"));
-            SamProps.AnisotropicFilteringSupported = GL_TEXTURE_MAX_ANISOTROPY_EXT && strstr(Extensions, "texture_filter_anisotropic");
-            SamProps.LODBiasSupported              = GL_TEXTURE_LOD_BIAS && IsGLES31OrAbove;
+            SamProps.BorderSamplingModeSupported = GL_TEXTURE_BORDER_COLOR && (IsGLES32OrAbove || strstr(Extensions, "texture_border_clamp"));
+            if (strstr(Extensions, "texture_filter_anisotropic"))
+            {
+                GLint MaxAnisotropy = 0;
+                glGetIntegerv(GL_MAX_TEXTURE_MAX_ANISOTROPY, &MaxAnisotropy);
+                CHECK_GL_ERROR("glGetIntegerv(GL_MAX_TEXTURE_MAX_ANISOTROPY)");
+                SamProps.MaxAnisotropy = static_cast<Uint8>(MaxAnisotropy);
+            }
+            SamProps.LODBiasSupported = GL_TEXTURE_LOD_BIAS && IsGLES31OrAbove;
             ASSERT_SIZEOF(SamProps, 3, "Did you add a new member to SamplerProperites? Please initialize it here.");
 
             m_GLCaps.FramebufferSRGB  = strstr(Extensions, "sRGB_write_control");

Graphics/GraphicsEngineOpenGL/src/SamplerGLImpl.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -101,12 +101,10 @@ SamplerGLImpl::SamplerGLImpl(IReferenceCounters* pRefCounters, class RenderDevic
             LOG_WARNING_MESSAGE("Texture LOD bias sampler attribute is not supported\n");
     }
 
-    if (SamPrpos.AnisotropicFilteringSupported) // Can be unsupported
-        glSamplerParameterf(m_GlSampler, GL_TEXTURE_MAX_ANISOTROPY_EXT, bMipAnisotropic ? static_cast<float>(SamplerDesc.MaxAnisotropy) : 1.f);
-    else
+    if (bMinAnisotropic && SamPrpos.MaxAnisotropy > 1)
     {
-        if (bMipAnisotropic && SamplerDesc.MaxAnisotropy != 1)
-            LOG_WARNING_MESSAGE("Max anisotropy sampler attribute is not supported\n");
+        float MaxAnisotropy = static_cast<float>(std::min(SamplerDesc.MaxAnisotropy, Uint32{SamPrpos.MaxAnisotropy}));
+        glSamplerParameterf(m_GlSampler, GL_TEXTURE_MAX_ANISOTROPY_EXT, MaxAnisotropy);
     }
 
     glSamplerParameteri(m_GlSampler, GL_TEXTURE_COMPARE_MODE, bMinComparison ? GL_COMPARE_REF_TO_TEXTURE : GL_NONE);

Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp

@@ -188,9 +188,9 @@ GraphicsAdapterInfo GetPhysicalDeviceGraphicsAdapterInfo(const VulkanUtilities::
     // Sampler properties
     {
         auto& SamProps{AdapterInfo.Sampler};
-        SamProps.BorderSamplingModeSupported   = True;
-        SamProps.AnisotropicFilteringSupported = vkFeatures.samplerAnisotropy;
-        SamProps.LODBiasSupported              = True;
+        SamProps.BorderSamplingModeSupported = True;
+        SamProps.MaxAnisotropy               = static_cast<Uint8>(vkDeviceLimits.maxSamplerAnisotropy);
+        SamProps.LODBiasSupported            = True;
         ASSERT_SIZEOF(SamProps, 3, "Did you add a new member to SamplerProperites? Please initialize it here.");
     }
 

ReleaseHistory.md

@@ -1,5 +1,6 @@
 ## Current progress
 
+* Replaced `AnisotropicFilteringSupported` member of `SamplerProperties` struct with `MaxAnisotropy` (API254004)
 * Added `TextureSubresourceViews` device feature (API254003)
 * Added device context rendering statistics (API254002)
   * Added `DeviceContextStats` struct

Tests/DiligentCoreAPITest/src/SamplerTest.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -117,7 +117,9 @@ TEST(FilterTypeTest, AnisotropicFilter)
 {
     auto* pEnv    = GPUTestingEnvironment::GetInstance();
     auto* pDevice = pEnv->GetDevice();
-    if (!pDevice->GetAdapterInfo().Sampler.AnisotropicFilteringSupported)
+
+    const Uint32 MaxAnisotropy = pDevice->GetAdapterInfo().Sampler.MaxAnisotropy;
+    if (MaxAnisotropy <= 1)
         GTEST_SKIP() << "Anisotropic filtering is not supported by this device";
 
     GPUTestingEnvironment::ScopedReleaseResources AutoreleaseResources;
@@ -129,7 +131,7 @@ TEST(FilterTypeTest, AnisotropicFilter)
         SamplerDesc.MagFilter = FILTER_TYPE_ANISOTROPIC;
         SamplerDesc.MipFilter = FILTER_TYPE_ANISOTROPIC;
 
-        SamplerDesc.MaxAnisotropy = 4;
+        SamplerDesc.MaxAnisotropy = std::min(4u, MaxAnisotropy);
         RefCntAutoPtr<ISampler> pSampler;
         pDevice->CreateSampler(SamplerDesc, &pSampler);
         ASSERT_TRUE(pSampler);
@@ -143,7 +145,7 @@ TEST(FilterTypeTest, AnisotropicFilter)
         SamplerDesc.MagFilter = FILTER_TYPE_COMPARISON_ANISOTROPIC;
         SamplerDesc.MipFilter = FILTER_TYPE_COMPARISON_ANISOTROPIC;
 
-        SamplerDesc.MaxAnisotropy = 4;
+        SamplerDesc.MaxAnisotropy = std::min(4u, MaxAnisotropy);
         RefCntAutoPtr<ISampler> pSampler;
         pDevice->CreateSampler(SamplerDesc, &pSampler);
         ASSERT_TRUE(pSampler);