Update present_mode docs as most of them don't automatically fall bac…

…k to Fifo anymore. (#2855) * space PresentMode no longer automatically falls back to Fifo * Update wgpu-types/src/lib.rs Auto(No)Vsync fallback wording. Co-authored-by: Connor Fitzgerald <[email protected]> * changelog Co-authored-by: Connor Fitzgerald <[email protected]>
gfx-rs · Jul 5, 2022 · ab340ba · ab340ba
1 parent 615ced5
commit ab340ba
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,6 +45,11 @@ Bottom level categories:
 #### DX12
 - `DownlevelCapabilities::default()` now returns the `ANISOTROPIC_FILTERING` flag set to true so DX12 lists `ANISOTROPIC_FILTERING` as true again by @cwfitzgerald in [#2851](https://github.com/gfx-rs/wgpu/pull/2851)
 
+### Documentation
+
+- Update present_mode docs as most of them don't automatically fall back to Fifo anymore. by @Elabajaba in [#2855](https://github.com/gfx-rs/wgpu/pull/2855)
+
+
 ## wgpu-0.13.1 (2022-07-02)
 
 ### Bug Fixes

diff --git a/wgpu-types/src/lib.rs b/wgpu-types/src/lib.rs
@@ -2994,7 +2994,7 @@ pub enum PresentMode {
     ///
     /// Tearing can be observed.
     ///
-    /// Supported on most platforms except older DX12.
+    /// Supported on most platforms except older DX12 and Wayland.
     ///
     /// This is traditionally called "Vsync Off".
     Immediate = 4,
@@ -3065,8 +3065,10 @@ pub struct SurfaceConfiguration {
     pub width: u32,
     /// Height of the swap chain. Must be the same size as the surface.
     pub height: u32,
-    /// Presentation mode of the swap chain. FIFO is the only guaranteed to be supported, though
-    /// other formats will automatically fall back to FIFO.
+    /// Presentation mode of the swap chain. Fifo is the only mode guaranteed to be supported.
+    /// FifoRelaxed, Immediate, and Mailbox will crash if unsupported, while AutoVsync and
+    /// AutoNoVsync will gracefully do a designed sets of fallbacks if their primary modes are
+    /// unsupported.
     pub present_mode: PresentMode,
 }