Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-26 22:50:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix and improve MSAA documentation (#16196)

Browse source 
# 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!
This commit is contained in:
Joona Aalto 2024-10-31 23:34:04 +02:00 committed by François
parent e0308ad920
commit f27449f8f0
No known key found for this signature in database
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
crates/bevy_render/src/view/mod.rs
View file

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