From 3e562aaeaae71ce60c3cb9a134161bf6625fcf2a Mon Sep 17 00:00:00 2001 From: Erich Gubler Date: Wed, 3 May 2023 06:08:52 -0400 Subject: [PATCH] docs: note feature req. for `Depth32FloatStencil8` (#3734) Co-authored-by: Connor Fitzgerald --- CHANGELOG.md | 6 ++++++ wgpu-core/src/resource.rs | 2 +- wgpu-types/src/lib.rs | 6 ++++-- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c77604fe3..a2d74346df 100644 --- 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 index 7abc20343b..6ea7b9cce0 100644 --- 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 index 98481be8b4..a4af880ef2 100644 --- 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.