Skip to content

Commit 97ec4a0

Browse files
kpreidcwfitzgerald
authored andcommitted
Explain where Device::features() and Device::limits() come from.
This clarifies that they are under user control and do not necessarily represent hard impossibilities.
1 parent 70415d0 commit 97ec4a0

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

wgpu/src/api/device.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,10 @@ impl Device {
9696
self.inner.poll(poll_type.map_index(|s| s.index))
9797
}
9898

99-
/// The features which can be used on this device.
99+
/// The [features][Features] which can be used on this device.
100100
///
101+
/// This will be equal to the [`required_features`][DeviceDescriptor::required_features]
102+
/// specified when creating the device.
101103
/// No additional features can be used, even if the underlying adapter can support them.
102104
#[must_use]
103105
pub fn features(&self) -> Features {
@@ -106,6 +108,8 @@ impl Device {
106108

107109
/// The limits which can be used on this device.
108110
///
111+
/// This will be equal to the [`required_limits`][DeviceDescriptor::required_limits]
112+
/// specified when creating the device.
109113
/// No better limits can be used, even if the underlying adapter can support them.
110114
#[must_use]
111115
pub fn limits(&self) -> Limits {

0 commit comments

Comments
 (0)