Skip to content

Commit 1b153ae

Browse files
committed
doc: Document the behavior when mis-configuring width/height of Surface
1 parent 0170dfe commit 1b153ae

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

wgpu-types/src/lib.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5530,8 +5530,18 @@ pub struct SurfaceConfiguration<V> {
55305530
/// `Bgra8Unorm` and `Bgra8UnormSrgb`
55315531
pub format: TextureFormat,
55325532
/// Width of the swap chain. Must be the same size as the surface, and nonzero.
5533+
///
5534+
/// If this is not the same size as the underlying surface (e.g. if it is
5535+
/// set once, and the window is later resized), the behaviour is defined
5536+
/// but platform-specific, and may change in the future (currently macOS
5537+
/// scales the surface, other platforms may do something else).
55335538
pub width: u32,
55345539
/// Height of the swap chain. Must be the same size as the surface, and nonzero.
5540+
///
5541+
/// If this is not the same size as the underlying surface (e.g. if it is
5542+
/// set once, and the window is later resized), the behaviour is defined
5543+
/// but platform-specific, and may change in the future (currently macOS
5544+
/// scales the surface, other platforms may do something else).
55355545
pub height: u32,
55365546
/// Presentation mode of the swap chain. Fifo is the only mode guaranteed to be supported.
55375547
/// FifoRelaxed, Immediate, and Mailbox will crash if unsupported, while AutoVsync and

0 commit comments

Comments
 (0)