Skip to content

Commit 06bae05

Browse files
IceSentryIceSentry
authored
Add bevy_anti_aliasing (#18323)
# Objective - bevy_core_pipeline is getting really big and it's a big bottleneck for compilation time. A lot of parts of it can be broken up ## Solution - Add a new bevy_anti_aliasing crate that contains all the anti_aliasing implementations - I didn't move any MSAA related code to this new crate because that's a lot more invasive ## Testing - Tested the anti_aliasing example to make sure all methods still worked --- ## Showcase before: ![image](https://github.com/user-attachments/assets/eac18276-2cb9-41c9-aaf4-a5da643a7ba7) after: ![image](https://github.com/user-attachments/assets/59cb2fb4-306f-4e42-b156-d5534da5685d) Notice that now bevy_core_pipeline is 1s shorter and bevy_anti_aliasing now compiles in parallel with bevy_pbr. ## Migration Guide When using anti aliasing features, you now need to import them from `bevy::anti_aliasing` instead of `bevy::core_pipeline`
1 parent f353cc3 commit 06bae05

36 files changed

+331
-50
lines changed

‎Cargo.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ default = [
133133
"bevy_audio",
134134
"bevy_color",
135135
"bevy_core_pipeline",
136+
"bevy_anti_aliasing",
136137
"bevy_gilrs",
137138
"bevy_gizmos",
138139
"bevy_gltf",
@@ -213,6 +214,13 @@ bevy_core_pipeline = [
213214
"bevy_render",
214215
]
215216

217+
# Provides various anti aliasing solutions
218+
bevy_anti_aliasing = [
219+
"bevy_internal/bevy_anti_aliasing",
220+
"bevy_asset",
221+
"bevy_render",
222+
]
223+
216224
# Adds gamepad support
217225
bevy_gilrs = ["bevy_internal/bevy_gilrs"]
218226

@@ -225,6 +233,7 @@ bevy_pbr = [
225233
"bevy_asset",
226234
"bevy_render",
227235
"bevy_core_pipeline",
236+
"bevy_anti_aliasing",
228237
]
229238

230239
# Provides picking functionality
@@ -242,6 +251,7 @@ bevy_sprite = [
242251
"bevy_render",
243252
"bevy_core_pipeline",
244253
"bevy_color",
254+
"bevy_anti_aliasing",
245255
]
246256

247257
# Provides text functionality
@@ -254,6 +264,7 @@ bevy_ui = [
254264
"bevy_text",
255265
"bevy_sprite",
256266
"bevy_color",
267+
"bevy_anti_aliasing",
257268
]
258269

259270
# Windowing layer

‎crates/bevy_anti_aliasing/Cargo.toml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[package]
2+
name = "bevy_anti_aliasing"
3+
version = "0.16.0-dev"
4+
edition = "2024"
5+
description = "Provides various anti aliasing implementations for Bevy Engine"
6+
homepage = "https://bevyengine.org"
7+
repository = "https://github.com/bevyengine/bevy"
8+
license = "MIT OR Apache-2.0"
9+
keywords = ["bevy"]
10+
11+
[features]
12+
trace = []
13+
webgl = []
14+
webgpu = []
15+
dds = ["bevy_render/dds", "bevy_image/dds"]
16+
smaa_luts = ["bevy_render/ktx2", "bevy_image/ktx2", "bevy_image/zstd"]
17+
18+
[dependencies]
19+
# bevy
20+
bevy_asset = { path = "../bevy_asset", version = "0.16.0-dev" }
21+
bevy_reflect = { path = "../bevy_reflect", version = "0.16.0-dev" }
22+
bevy_render = { path = "../bevy_render", version = "0.16.0-dev" }
23+
bevy_math = { path = "../bevy_math", version = "0.16.0-dev" }
24+
bevy_utils = { path = "../bevy_utils", version = "0.16.0-dev" }
25+
bevy_app = { path = "../bevy_app", version = "0.16.0-dev" }
26+
bevy_image = { path = "../bevy_image", version = "0.16.0-dev" }
27+
bevy_derive = { path = "../bevy_derive", version = "0.16.0-dev" }
28+
bevy_ecs = { path = "../bevy_ecs", version = "0.16.0-dev" }
29+
bevy_core_pipeline = { path = "../bevy_core_pipeline", version = "0.16.0-dev" }
30+
bevy_diagnostic = { path = "../bevy_diagnostic", version = "0.16.0-dev" }
31+
32+
# other
33+
tracing = { version = "0.1", default-features = false, features = ["std"] }
34+
35+
[lints]
36+
workspace = true
37+
38+
[package.metadata.docs.rs]
39+
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
40+
all-features = true

‎crates/bevy_anti_aliasing/LICENSE-APACHE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎crates/bevy_anti_aliasing/LICENSE-MIT

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
MIT License
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎crates/bevy_anti_aliasing/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Bevy Anti Aliasing
2+
3+
[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license)
4+
[![Crates.io](https://img.shields.io/crates/v/bevy_core_pipeline.svg)](https://crates.io/crates/bevy_core_pipeline)
5+
[![Downloads](https://img.shields.io/crates/d/bevy_core_pipeline.svg)](https://crates.io/crates/bevy_core_pipeline)
6+
[![Docs](https://docs.rs/bevy_core_pipeline/badge.svg)](https://docs.rs/bevy_core_pipeline/latest/bevy_core_pipeline/)
7+
[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy)

‎crates/bevy_core_pipeline/src/contrast_adaptive_sharpening/mod.rs renamed to ‎crates/bevy_anti_aliasing/src/contrast_adaptive_sharpening/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
use crate::{
1+
use bevy_app::prelude::*;
2+
use bevy_asset::{load_internal_asset, weak_handle, Handle};
3+
use bevy_core_pipeline::{
24
core_2d::graph::{Core2d, Node2d},
35
core_3d::graph::{Core3d, Node3d},
46
fullscreen_vertex_shader::fullscreen_shader_vertex_state,
57
};
6-
use bevy_app::prelude::*;
7-
use bevy_asset::{load_internal_asset, weak_handle, Handle};
88
use bevy_ecs::{prelude::*, query::QueryItem};
99
use bevy_image::BevyDefault as _;
1010
use bevy_reflect::{std_traits::ReflectDefault, Reflect};

‎crates/bevy_core_pipeline/src/contrast_adaptive_sharpening/node.rs renamed to ‎crates/bevy_anti_aliasing/src/contrast_adaptive_sharpening/node.rs

File renamed without changes.

‎crates/bevy_core_pipeline/src/contrast_adaptive_sharpening/robust_contrast_adaptive_sharpening.wgsl renamed to ‎crates/bevy_anti_aliasing/src/contrast_adaptive_sharpening/robust_contrast_adaptive_sharpening.wgsl

File renamed without changes.

‎crates/bevy_anti_aliasing/src/experimental/mod.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
//! Experimental rendering features.
2+
//!
3+
//! Experimental features are features with known problems, missing features,
4+
//! compatibility issues, low performance, and/or future breaking changes, but
5+
//! are included nonetheless for testing purposes.
6+
7+
pub mod taa {
8+
pub use crate::taa::{TemporalAntiAliasNode, TemporalAntiAliasPlugin, TemporalAntiAliasing};
9+
}

‎crates/bevy_core_pipeline/src/fxaa/fxaa.wgsl renamed to ‎crates/bevy_anti_aliasing/src/fxaa/fxaa.wgsl

File renamed without changes.

‎crates/bevy_core_pipeline/src/fxaa/mod.rs renamed to ‎crates/bevy_anti_aliasing/src/fxaa/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
use crate::{
1+
use bevy_app::prelude::*;
2+
use bevy_asset::{load_internal_asset, weak_handle, Handle};
3+
use bevy_core_pipeline::{
24
core_2d::graph::{Core2d, Node2d},
35
core_3d::graph::{Core3d, Node3d},
46
fullscreen_vertex_shader::fullscreen_shader_vertex_state,
57
};
6-
use bevy_app::prelude::*;
7-
use bevy_asset::{load_internal_asset, weak_handle, Handle};
88
use bevy_ecs::prelude::*;
99
use bevy_image::BevyDefault as _;
1010
use bevy_reflect::{std_traits::ReflectDefault, Reflect};

‎crates/bevy_core_pipeline/src/fxaa/node.rs renamed to ‎crates/bevy_anti_aliasing/src/fxaa/node.rs

File renamed without changes.

‎crates/bevy_anti_aliasing/src/lib.rs

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
2+
#![forbid(unsafe_code)]
3+
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
4+
#![doc(
5+
html_logo_url = "https://bevyengine.org/assets/icon.png",
6+
html_favicon_url = "https://bevyengine.org/assets/icon.png"
7+
)]
8+
9+
use bevy_app::Plugin;
10+
use contrast_adaptive_sharpening::CasPlugin;
11+
use fxaa::FxaaPlugin;
12+
use smaa::SmaaPlugin;
13+
14+
pub mod contrast_adaptive_sharpening;
15+
pub mod experimental;
16+
pub mod fxaa;
17+
pub mod smaa;
18+
19+
mod taa;
20+
21+
#[derive(Default)]
22+
pub struct AntiAliasingPlugin;
23+
impl Plugin for AntiAliasingPlugin {
24+
fn build(&self, app: &mut bevy_app::App) {
25+
app.add_plugins((FxaaPlugin, CasPlugin, SmaaPlugin));
26+
}
27+
}

‎crates/bevy_core_pipeline/src/smaa/SMAAAreaLUT.ktx2 renamed to ‎crates/bevy_anti_aliasing/src/smaa/SMAAAreaLUT.ktx2

File renamed without changes.

‎crates/bevy_core_pipeline/src/smaa/SMAASearchLUT.ktx2 renamed to ‎crates/bevy_anti_aliasing/src/smaa/SMAASearchLUT.ktx2

File renamed without changes.

‎crates/bevy_core_pipeline/src/smaa/mod.rs renamed to ‎crates/bevy_anti_aliasing/src/smaa/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@
2929
//! * Compatibility with SSAA and MSAA.
3030
//!
3131
//! [SMAA]: https://www.iryoku.com/smaa/
32-
#[cfg(not(feature = "smaa_luts"))]
33-
use crate::tonemapping::lut_placeholder;
34-
use crate::{
35-
core_2d::graph::{Core2d, Node2d},
36-
core_3d::graph::{Core3d, Node3d},
37-
};
3832
use bevy_app::{App, Plugin};
3933
#[cfg(feature = "smaa_luts")]
4034
use bevy_asset::load_internal_binary_asset;
4135
use bevy_asset::{load_internal_asset, weak_handle, Handle};
36+
#[cfg(not(feature = "smaa_luts"))]
37+
use bevy_core_pipeline::tonemapping::lut_placeholder;
38+
use bevy_core_pipeline::{
39+
core_2d::graph::{Core2d, Node2d},
40+
core_3d::graph::{Core3d, Node3d},
41+
};
4242
use bevy_derive::{Deref, DerefMut};
4343
use bevy_ecs::{
4444
component::Component,

‎crates/bevy_core_pipeline/src/smaa/smaa.wgsl renamed to ‎crates/bevy_anti_aliasing/src/smaa/smaa.wgsl

File renamed without changes.

‎crates/bevy_core_pipeline/src/taa/mod.rs renamed to ‎crates/bevy_anti_aliasing/src/taa/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
use crate::{
1+
use bevy_app::{App, Plugin};
2+
use bevy_asset::{load_internal_asset, weak_handle, Handle};
3+
use bevy_core_pipeline::{
24
core_3d::graph::{Core3d, Node3d},
35
fullscreen_vertex_shader::fullscreen_shader_vertex_state,
46
prelude::Camera3d,
57
prepass::{DepthPrepass, MotionVectorPrepass, ViewPrepassTextures},
68
};
7-
use bevy_app::{App, Plugin};
8-
use bevy_asset::{load_internal_asset, weak_handle, Handle};
99
use bevy_diagnostic::FrameCount;
1010
use bevy_ecs::{
1111
prelude::{Component, Entity, ReflectComponent},

‎crates/bevy_core_pipeline/src/taa/taa.wgsl renamed to ‎crates/bevy_anti_aliasing/src/taa/taa.wgsl

File renamed without changes.

0 commit comments

Comments
 (0)