Skip to content

Commit 4656698

Browse files
authored
Fix and improve MSAA documentation (#16196)
# Objective #14273 changed `Msaa` to be a component rather than a resource. However, the documentation still says that it is a resource. This tripped me up during migration to 0.15 until I looked at the type definition. Additionally, the docs have some unnecessary repetition and some grammar mistakes, and they don't link to camera documentation. ## Solution Fix up the docs!
1 parent 03a068e commit 4656698

File tree

1 file changed

+5
-5
lines changed
  • crates/bevy_render/src/view

1 file changed

+5
-5
lines changed

crates/bevy_render/src/view/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,14 +146,14 @@ impl Plugin for ViewPlugin {
146146
}
147147
}
148148

149-
/// Configuration resource for [Multi-Sample Anti-Aliasing](https://en.wikipedia.org/wiki/Multisample_anti-aliasing).
149+
/// Component for configuring the number of samples for [Multi-Sample Anti-Aliasing](https://en.wikipedia.org/wiki/Multisample_anti-aliasing)
150+
/// for a [`Camera`](crate::camera::Camera).
150151
///
151-
/// The number of samples to run for Multi-Sample Anti-Aliasing for a given camera. Higher numbers
152-
/// result in smoother edges.
152+
/// Defaults to 4 samples. A higher number of samples results in smoother edges.
153153
///
154-
/// Defaults to 4 samples. Some advanced rendering features may require that MSAA be disabled.
154+
/// Some advanced rendering features may require that MSAA is disabled.
155155
///
156-
/// Note that web currently only supports 1 or 4 samples.
156+
/// Note that the web currently only supports 1 or 4 samples.
157157
#[derive(
158158
Component,
159159
Default,

0 commit comments

Comments
 (0)