docs: note feature req. for Depth32FloatStencil8 (#3734)

Co-authored-by: Connor Fitzgerald <connorwadefitzgerald@gmail.com>
gfx-rs · May 3, 2023 · 3e562aa · 3e562aa
1 parent 1dd105c
commit 3e562aa
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,12 @@ Bottom level categories:
 
 ## Unreleased
 
+### Documentation
+
+#### General
+
+- Document feature requirements for `DEPTH32FLOAT_STENCIL8` by @ErichDonGubler in [#3734](https://github.com/gfx-rs/wgpu/pull/3734).
+
 ### Bug Fixes
 
 #### General

diff --git a/wgpu-core/src/resource.rs b/wgpu-core/src/resource.rs
@@ -523,7 +523,7 @@ pub enum CreateTextureError {
     InvalidSampleCount(u32, wgt::TextureFormat),
     #[error("Multisampled textures must have RENDER_ATTACHMENT usage")]
     MultisampledNotRenderAttachment,
-    #[error("Texture format {0:?} can't be used due to missing features.")]
+    #[error("Texture format {0:?} can't be used due to missing features")]
     MissingFeatures(wgt::TextureFormat, #[source] MissingFeatures),
     #[error(transparent)]
     MissingDownlevelFlags(#[from] MissingDownlevelFlags),

diff --git a/wgpu-types/src/lib.rs b/wgpu-types/src/lib.rs
@@ -270,7 +270,7 @@ bitflags::bitflags! {
 
         /// Allows shaders to acquire the FP16 ability
         ///
-        /// Note: this is not supported in naga yet，only through spir-v passthrough right now.
+        /// Note: this is not supported in `naga` yet，only through `spirv-passthrough` right now.
         ///
         /// Supported Platforms:
         /// - Vulkan
@@ -728,7 +728,7 @@ bitflags::bitflags! {
         ///
         /// This is a native only feature.
         const SHADER_F64 = 1 << 59;
-        /// Allows shaders to use i16. Not currently supported in naga, only available through `spirv-passthrough`.
+        /// Allows shaders to use i16. Not currently supported in `naga`, only available through `spirv-passthrough`.
         ///
         /// Supported platforms:
         /// - Vulkan
@@ -2025,6 +2025,8 @@ pub enum TextureFormat {
     /// Special depth format with 32 bit floating point depth.
     Depth32Float,
     /// Special depth/stencil format with 32 bit floating point depth and 8 bits integer stencil.
+    ///
+    /// [`Features::DEPTH32FLOAT_STENCIL8`] must be enabled to use this texture format.
     Depth32FloatStencil8,
 
     // Compressed textures usable with `TEXTURE_COMPRESSION_BC` feature.