Skip to content

Commit

Permalink
Fix and improve MSAA documentation (#16196)
Browse files Browse the repository at this point in the history
# 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!
  • Loading branch information
Jondolf authored and mockersf committed Nov 5, 2024
1 parent e0308ad commit f27449f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions crates/bevy_render/src/view/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,14 @@ impl Plugin for ViewPlugin {
}
}

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

0 comments on commit f27449f

Please sign in to comment.