Update present_mode docs as most of them don't automatically fall back 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 <connorwadefitzgerald@gmail.com>

* changelog

Co-authored-by: Connor Fitzgerald <connorwadefitzgerald@gmail.com>
This commit is contained in:
Elabajaba 2022-07-05 16:59:41 -04:00 committed by GitHub
parent 615ced5a99
commit ab340baf69
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 3 deletions

View File

@ -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

View File

@ -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,
}