Skip to content

Commit abaea01

Browse files
authored
Fixup Msaa docs. (#14442)
Minor doc fixes missed in #14273
1 parent 3faca1e commit abaea01

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

crates/bevy_core_pipeline/src/smaa/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
//! To use SMAA, add [`SmaaSettings`] to a [`bevy_render::camera::Camera`]. In a
1515
//! pinch, you can simply use the default settings (via the [`Default`] trait)
1616
//! for a high-quality, high-performance appearance. When using SMAA, you will
17-
//! likely want to turn the default MSAA off by inserting the
18-
//! [`bevy_render::view::Msaa::Off`] resource into the [`App`].
17+
//! likely want set [`bevy_render::view::Msaa`] to [`bevy_render::view::Msaa::Off`]
18+
//! for every camera using SMAA.
1919
//!
2020
//! Those who have used SMAA in other engines should be aware that Bevy doesn't
2121
//! yet support the following more advanced features of SMAA:

crates/bevy_core_pipeline/src/taa/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ use bevy_utils::tracing::warn;
3838

3939
const TAA_SHADER_HANDLE: Handle<Shader> = Handle::weak_from_u128(656865235226276);
4040

41-
/// Plugin for temporal anti-aliasing. Disables multisample anti-aliasing (MSAA).
41+
/// Plugin for temporal anti-aliasing.
4242
///
4343
/// See [`TemporalAntiAliasSettings`] for more details.
4444
pub struct TemporalAntiAliasPlugin;
@@ -118,6 +118,8 @@ pub struct TemporalAntiAliasBundle {
118118
///
119119
/// # Usage Notes
120120
///
121+
/// Any camera with this component must also disable [`Msaa`] by setting it to [`Msaa::Off`].
122+
///
121123
/// Requires that you add [`TemporalAntiAliasPlugin`] to your app,
122124
/// and add the [`DepthPrepass`], [`MotionVectorPrepass`], and [`TemporalJitter`]
123125
/// components to your camera.

crates/bevy_pbr/src/meshlet/mod.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ const MESHLET_MESH_MATERIAL_SHADER_HANDLE: Handle<Shader> =
105105
/// * Requires preprocessing meshes. See [`MeshletMesh`] for details.
106106
/// * Limitations on the kinds of materials you can use. See [`MeshletMesh`] for details.
107107
///
108-
/// This plugin is not compatible with [`Msaa`], and adding this plugin will disable it.
108+
/// This plugin is not compatible with [`Msaa`]. Any camera rendering a [`MeshletMesh`] must have
109+
/// [`Msaa`] set to [`Msaa::Off`].
109110
///
110111
/// This plugin does not work on WASM.
111112
///

0 commit comments

Comments
 (0)