forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixup Msaa docs. (#14442)

Browse Source 
Minor doc fixes missed in #14273
This commit is contained in:
charlotte 2024-07-22 14:37:25 -07:00 committed by GitHub
parent 3faca1e549
commit abaea01e30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_core_pipeline/src/smaa/mod.rs
View File

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

4
crates/bevy_core_pipeline/src/taa/mod.rs
View File

@ -38,7 +38,7 @@ use bevy_utils::tracing::warn;
const TAA_SHADER_HANDLE: Handle<Shader> = Handle::weak_from_u128(656865235226276); const TAA_SHADER_HANDLE: Handle<Shader> = Handle::weak_from_u128(656865235226276);
/// Plugin for temporal anti-aliasing. Disables multisample anti-aliasing (MSAA). /// Plugin for temporal anti-aliasing.
/// ///
/// See [`TemporalAntiAliasSettings`] for more details. /// See [`TemporalAntiAliasSettings`] for more details.
pub struct TemporalAntiAliasPlugin; pub struct TemporalAntiAliasPlugin;
@ -118,6 +118,8 @@ pub struct TemporalAntiAliasBundle {
/// ///
/// # Usage Notes /// # Usage Notes
/// ///
/// Any camera with this component must also disable [`Msaa`] by setting it to [`Msaa::Off`].
///
/// Requires that you add [`TemporalAntiAliasPlugin`] to your app, /// Requires that you add [`TemporalAntiAliasPlugin`] to your app,
/// and add the [`DepthPrepass`], [`MotionVectorPrepass`], and [`TemporalJitter`] /// and add the [`DepthPrepass`], [`MotionVectorPrepass`], and [`TemporalJitter`]
/// components to your camera. /// components to your camera.

3
crates/bevy_pbr/src/meshlet/mod.rs
View File

@ -105,7 +105,8 @@ const MESHLET_MESH_MATERIAL_SHADER_HANDLE: Handle<Shader> =
/// * Requires preprocessing meshes. See [`MeshletMesh`] for details. /// * Requires preprocessing meshes. See [`MeshletMesh`] for details.
/// * Limitations on the kinds of materials you can use. See [`MeshletMesh`] for details. /// * Limitations on the kinds of materials you can use. See [`MeshletMesh`] for details.
/// ///
/// This plugin is not compatible with [`Msaa`], and adding this plugin will disable it. /// This plugin is not compatible with [`Msaa`]. Any camera rendering a [`MeshletMesh`] must have
/// [`Msaa`] set to [`Msaa::Off`].
/// ///
/// This plugin does not work on WASM. /// This plugin does not work on WASM.
/// ///