Skip to content

Commit f83de49

Browse files
authored
Rename Core Render Graph Labels (#11882)
# Objective #10644 introduced nice "statically typed" labels that replace the old strings. I would like to propose some changes to the names introduced: * `SubGraph2d` -> `Core2d` and `SubGraph3d` -> `Core3d`. The names of these graphs have been / should continue to be the "core 2d" graph not the "sub graph 2d" graph. The crate is called `bevy_core_pipeline`, the modules are still `core_2d` and `core_3d`, etc. * `Labels2d` and `Labels3d`, at the very least, should not be plural to follow naming conventions. A Label enum is not a "collection of labels", it is a _specific_ Label. However I think `Label2d` and `Label3d` is significantly less clear than `Node2d` and `Node3d`, so I propose those changes here. I've done the same for `LabelsPbr` -> `NodePbr` and `LabelsUi` -> `NodeUi` Additionally, #10644 accidentally made one of the Camera2dBundle constructors use the 3D graph instead of the 2D graph. I've fixed that here. --- ## Changelog * Renamed `SubGraph2d` -> `Core2d`, `SubGraph3d` -> `Core3d`, `Labels2d` -> `Node2d`, `Labels3d` -> `Node3d`, `LabelsUi` -> `NodeUi`, `LabelsPbr` -> `NodePbr`
1 parent 4ebc560 commit f83de49

File tree

15 files changed

+198
-220
lines changed

15 files changed

+198
-220
lines changed

crates/bevy_core_pipeline/src/bloom/mod.rs

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ mod upsampling_pipeline;
55
pub use settings::{BloomCompositeMode, BloomPrefilterSettings, BloomSettings};
66

77
use crate::{
8-
core_2d::graph::{Labels2d, SubGraph2d},
9-
core_3d::graph::{Labels3d, SubGraph3d},
8+
core_2d::graph::{Core2d, Node2d},
9+
core_3d::graph::{Core3d, Node3d},
1010
};
1111
use bevy_app::{App, Plugin};
1212
use bevy_asset::{load_internal_asset, Handle};
@@ -72,20 +72,16 @@ impl Plugin for BloomPlugin {
7272
),
7373
)
7474
// Add bloom to the 3d render graph
75-
.add_render_graph_node::<ViewNodeRunner<BloomNode>>(SubGraph3d, Labels3d::Bloom)
75+
.add_render_graph_node::<ViewNodeRunner<BloomNode>>(Core3d, Node3d::Bloom)
7676
.add_render_graph_edges(
77-
SubGraph3d,
78-
(
79-
Labels3d::EndMainPass,
80-
Labels3d::Bloom,
81-
Labels3d::Tonemapping,
82-
),
77+
Core3d,
78+
(Node3d::EndMainPass, Node3d::Bloom, Node3d::Tonemapping),
8379
)
8480
// Add bloom to the 2d render graph
85-
.add_render_graph_node::<ViewNodeRunner<BloomNode>>(SubGraph2d, Labels2d::Bloom)
81+
.add_render_graph_node::<ViewNodeRunner<BloomNode>>(Core2d, Node2d::Bloom)
8682
.add_render_graph_edges(
87-
SubGraph2d,
88-
(Labels2d::MainPass, Labels2d::Bloom, Labels2d::Tonemapping),
83+
Core2d,
84+
(Node2d::MainPass, Node2d::Bloom, Node2d::Tonemapping),
8985
);
9086
}
9187

crates/bevy_core_pipeline/src/contrast_adaptive_sharpening/mod.rs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::{
2-
core_2d::graph::{Labels2d, SubGraph2d},
3-
core_3d::graph::{Labels3d, SubGraph3d},
2+
core_2d::graph::{Core2d, Node2d},
3+
core_3d::graph::{Core3d, Node3d},
44
fullscreen_vertex_shader::fullscreen_shader_vertex_state,
55
};
66
use bevy_app::prelude::*;
@@ -125,35 +125,35 @@ impl Plugin for CASPlugin {
125125

126126
{
127127
render_app
128-
.add_render_graph_node::<CASNode>(SubGraph3d, Labels3d::ContrastAdaptiveSharpening)
128+
.add_render_graph_node::<CASNode>(Core3d, Node3d::ContrastAdaptiveSharpening)
129129
.add_render_graph_edge(
130-
SubGraph3d,
131-
Labels3d::Tonemapping,
132-
Labels3d::ContrastAdaptiveSharpening,
130+
Core3d,
131+
Node3d::Tonemapping,
132+
Node3d::ContrastAdaptiveSharpening,
133133
)
134134
.add_render_graph_edges(
135-
SubGraph3d,
135+
Core3d,
136136
(
137-
Labels3d::Fxaa,
138-
Labels3d::ContrastAdaptiveSharpening,
139-
Labels3d::EndMainPassPostProcessing,
137+
Node3d::Fxaa,
138+
Node3d::ContrastAdaptiveSharpening,
139+
Node3d::EndMainPassPostProcessing,
140140
),
141141
);
142142
}
143143
{
144144
render_app
145-
.add_render_graph_node::<CASNode>(SubGraph2d, Labels2d::ConstrastAdaptiveSharpening)
145+
.add_render_graph_node::<CASNode>(Core2d, Node2d::ConstrastAdaptiveSharpening)
146146
.add_render_graph_edge(
147-
SubGraph2d,
148-
Labels2d::Tonemapping,
149-
Labels2d::ConstrastAdaptiveSharpening,
147+
Core2d,
148+
Node2d::Tonemapping,
149+
Node2d::ConstrastAdaptiveSharpening,
150150
)
151151
.add_render_graph_edges(
152-
SubGraph2d,
152+
Core2d,
153153
(
154-
Labels2d::Fxaa,
155-
Labels2d::ConstrastAdaptiveSharpening,
156-
Labels2d::EndMainPassPostProcessing,
154+
Node2d::Fxaa,
155+
Node2d::ConstrastAdaptiveSharpening,
156+
Node2d::EndMainPassPostProcessing,
157157
),
158158
);
159159
}

crates/bevy_core_pipeline/src/core_2d/camera_2d.rs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
use crate::{
2-
core_3d::graph::SubGraph3d,
3-
tonemapping::{DebandDither, Tonemapping},
4-
};
1+
use crate::core_2d::graph::Core2d;
2+
use crate::tonemapping::{DebandDither, Tonemapping};
53
use bevy_ecs::prelude::*;
64
use bevy_reflect::Reflect;
75
use bevy_render::{
@@ -15,8 +13,6 @@ use bevy_render::{
1513
};
1614
use bevy_transform::prelude::{GlobalTransform, Transform};
1715

18-
use super::graph::SubGraph2d;
19-
2016
#[derive(Component, Default, Reflect, Clone, ExtractComponent)]
2117
#[extract_component_filter(With<Camera>)]
2218
#[reflect(Component)]
@@ -47,7 +43,7 @@ impl Default for Camera2dBundle {
4743
let transform = Transform::default();
4844
let frustum = projection.compute_frustum(&GlobalTransform::from(transform));
4945
Self {
50-
camera_render_graph: CameraRenderGraph::new(SubGraph2d),
46+
camera_render_graph: CameraRenderGraph::new(Core2d),
5147
projection,
5248
visible_entities: VisibleEntities::default(),
5349
frustum,
@@ -79,7 +75,7 @@ impl Camera2dBundle {
7975
let transform = Transform::from_xyz(0.0, 0.0, far - 0.1);
8076
let frustum = projection.compute_frustum(&GlobalTransform::from(transform));
8177
Self {
82-
camera_render_graph: CameraRenderGraph::new(SubGraph3d),
78+
camera_render_graph: CameraRenderGraph::new(Core2d),
8379
projection,
8480
visible_entities: VisibleEntities::default(),
8581
frustum,

crates/bevy_core_pipeline/src/core_2d/mod.rs

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ pub mod graph {
55
use bevy_render::render_graph::{RenderLabel, RenderSubGraph};
66

77
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderSubGraph)]
8-
pub struct SubGraph2d;
8+
pub struct Core2d;
99

1010
pub mod input {
1111
pub const VIEW_ENTITY: &str = "view_entity";
1212
}
1313

1414
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderLabel)]
15-
pub enum Labels2d {
15+
pub enum Node2d {
1616
MsaaWriteback,
1717
MainPass,
1818
Bloom,
@@ -46,7 +46,7 @@ use bevy_utils::{nonmax::NonMaxU32, FloatOrd};
4646

4747
use crate::{tonemapping::TonemappingNode, upscaling::UpscalingNode};
4848

49-
use self::graph::{Labels2d, SubGraph2d};
49+
use self::graph::{Core2d, Node2d};
5050

5151
pub struct Core2dPlugin;
5252

@@ -68,21 +68,18 @@ impl Plugin for Core2dPlugin {
6868
);
6969

7070
render_app
71-
.add_render_sub_graph(SubGraph2d)
72-
.add_render_graph_node::<MainPass2dNode>(SubGraph2d, Labels2d::MainPass)
73-
.add_render_graph_node::<ViewNodeRunner<TonemappingNode>>(
74-
SubGraph2d,
75-
Labels2d::Tonemapping,
76-
)
77-
.add_render_graph_node::<EmptyNode>(SubGraph2d, Labels2d::EndMainPassPostProcessing)
78-
.add_render_graph_node::<ViewNodeRunner<UpscalingNode>>(SubGraph2d, Labels2d::Upscaling)
71+
.add_render_sub_graph(Core2d)
72+
.add_render_graph_node::<MainPass2dNode>(Core2d, Node2d::MainPass)
73+
.add_render_graph_node::<ViewNodeRunner<TonemappingNode>>(Core2d, Node2d::Tonemapping)
74+
.add_render_graph_node::<EmptyNode>(Core2d, Node2d::EndMainPassPostProcessing)
75+
.add_render_graph_node::<ViewNodeRunner<UpscalingNode>>(Core2d, Node2d::Upscaling)
7976
.add_render_graph_edges(
80-
SubGraph2d,
77+
Core2d,
8178
(
82-
Labels2d::MainPass,
83-
Labels2d::Tonemapping,
84-
Labels2d::EndMainPassPostProcessing,
85-
Labels2d::Upscaling,
79+
Node2d::MainPass,
80+
Node2d::Tonemapping,
81+
Node2d::EndMainPassPostProcessing,
82+
Node2d::Upscaling,
8683
),
8784
);
8885
}

crates/bevy_core_pipeline/src/core_3d/camera_3d.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
use crate::tonemapping::{DebandDither, Tonemapping};
1+
use crate::{
2+
core_3d::graph::Core3d,
3+
tonemapping::{DebandDither, Tonemapping},
4+
};
25
use bevy_ecs::prelude::*;
36
use bevy_reflect::{Reflect, ReflectDeserialize, ReflectSerialize};
47
use bevy_render::{
@@ -11,8 +14,6 @@ use bevy_render::{
1114
use bevy_transform::prelude::{GlobalTransform, Transform};
1215
use serde::{Deserialize, Serialize};
1316

14-
use super::graph::SubGraph3d;
15-
1617
/// Configuration for the "main 3d render graph".
1718
#[derive(Component, Reflect, Clone, ExtractComponent)]
1819
#[extract_component_filter(With<Camera>)]
@@ -153,7 +154,7 @@ pub struct Camera3dBundle {
153154
impl Default for Camera3dBundle {
154155
fn default() -> Self {
155156
Self {
156-
camera_render_graph: CameraRenderGraph::new(SubGraph3d),
157+
camera_render_graph: CameraRenderGraph::new(Core3d),
157158
camera: Default::default(),
158159
projection: Default::default(),
159160
visible_entities: Default::default(),

crates/bevy_core_pipeline/src/core_3d/mod.rs

Lines changed: 34 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ pub mod graph {
77
use bevy_render::render_graph::{RenderLabel, RenderSubGraph};
88

99
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderSubGraph)]
10-
pub struct SubGraph3d;
10+
pub struct Core3d;
1111

1212
pub mod input {
1313
pub const VIEW_ENTITY: &str = "view_entity";
1414
}
1515

1616
#[derive(Debug, Hash, PartialEq, Eq, Clone, RenderLabel)]
17-
pub enum Labels3d {
17+
pub enum Node3d {
1818
MsaaWriteback,
1919
Prepass,
2020
DeferredPrepass,
@@ -86,7 +86,7 @@ use crate::{
8686
upscaling::UpscalingNode,
8787
};
8888

89-
use self::graph::{Labels3d, SubGraph3d};
89+
use self::graph::{Core3d, Node3d};
9090

9191
pub struct Core3dPlugin;
9292

@@ -132,52 +132,49 @@ impl Plugin for Core3dPlugin {
132132
);
133133

134134
render_app
135-
.add_render_sub_graph(SubGraph3d)
136-
.add_render_graph_node::<ViewNodeRunner<PrepassNode>>(SubGraph3d, Labels3d::Prepass)
135+
.add_render_sub_graph(Core3d)
136+
.add_render_graph_node::<ViewNodeRunner<PrepassNode>>(Core3d, Node3d::Prepass)
137137
.add_render_graph_node::<ViewNodeRunner<DeferredGBufferPrepassNode>>(
138-
SubGraph3d,
139-
Labels3d::DeferredPrepass,
138+
Core3d,
139+
Node3d::DeferredPrepass,
140140
)
141141
.add_render_graph_node::<ViewNodeRunner<CopyDeferredLightingIdNode>>(
142-
SubGraph3d,
143-
Labels3d::CopyDeferredLightingId,
142+
Core3d,
143+
Node3d::CopyDeferredLightingId,
144144
)
145-
.add_render_graph_node::<EmptyNode>(SubGraph3d, Labels3d::EndPrepasses)
146-
.add_render_graph_node::<EmptyNode>(SubGraph3d, Labels3d::StartMainPass)
145+
.add_render_graph_node::<EmptyNode>(Core3d, Node3d::EndPrepasses)
146+
.add_render_graph_node::<EmptyNode>(Core3d, Node3d::StartMainPass)
147147
.add_render_graph_node::<ViewNodeRunner<MainOpaquePass3dNode>>(
148-
SubGraph3d,
149-
Labels3d::MainOpaquePass,
148+
Core3d,
149+
Node3d::MainOpaquePass,
150150
)
151151
.add_render_graph_node::<ViewNodeRunner<MainTransmissivePass3dNode>>(
152-
SubGraph3d,
153-
Labels3d::MainTransmissivePass,
152+
Core3d,
153+
Node3d::MainTransmissivePass,
154154
)
155155
.add_render_graph_node::<ViewNodeRunner<MainTransparentPass3dNode>>(
156-
SubGraph3d,
157-
Labels3d::MainTransparentPass,
156+
Core3d,
157+
Node3d::MainTransparentPass,
158158
)
159-
.add_render_graph_node::<EmptyNode>(SubGraph3d, Labels3d::EndMainPass)
160-
.add_render_graph_node::<ViewNodeRunner<TonemappingNode>>(
161-
SubGraph3d,
162-
Labels3d::Tonemapping,
163-
)
164-
.add_render_graph_node::<EmptyNode>(SubGraph3d, Labels3d::EndMainPassPostProcessing)
165-
.add_render_graph_node::<ViewNodeRunner<UpscalingNode>>(SubGraph3d, Labels3d::Upscaling)
159+
.add_render_graph_node::<EmptyNode>(Core3d, Node3d::EndMainPass)
160+
.add_render_graph_node::<ViewNodeRunner<TonemappingNode>>(Core3d, Node3d::Tonemapping)
161+
.add_render_graph_node::<EmptyNode>(Core3d, Node3d::EndMainPassPostProcessing)
162+
.add_render_graph_node::<ViewNodeRunner<UpscalingNode>>(Core3d, Node3d::Upscaling)
166163
.add_render_graph_edges(
167-
SubGraph3d,
164+
Core3d,
168165
(
169-
Labels3d::Prepass,
170-
Labels3d::DeferredPrepass,
171-
Labels3d::CopyDeferredLightingId,
172-
Labels3d::EndPrepasses,
173-
Labels3d::StartMainPass,
174-
Labels3d::MainOpaquePass,
175-
Labels3d::MainTransmissivePass,
176-
Labels3d::MainTransparentPass,
177-
Labels3d::EndMainPass,
178-
Labels3d::Tonemapping,
179-
Labels3d::EndMainPassPostProcessing,
180-
Labels3d::Upscaling,
166+
Node3d::Prepass,
167+
Node3d::DeferredPrepass,
168+
Node3d::CopyDeferredLightingId,
169+
Node3d::EndPrepasses,
170+
Node3d::StartMainPass,
171+
Node3d::MainOpaquePass,
172+
Node3d::MainTransmissivePass,
173+
Node3d::MainTransparentPass,
174+
Node3d::EndMainPass,
175+
Node3d::Tonemapping,
176+
Node3d::EndMainPassPostProcessing,
177+
Node3d::Upscaling,
181178
),
182179
);
183180
}

crates/bevy_core_pipeline/src/fxaa/mod.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::{
2-
core_2d::graph::{Labels2d, SubGraph2d},
3-
core_3d::graph::{Labels3d, SubGraph3d},
2+
core_2d::graph::{Core2d, Node2d},
3+
core_3d::graph::{Core3d, Node3d},
44
fullscreen_vertex_shader::fullscreen_shader_vertex_state,
55
};
66
use bevy_app::prelude::*;
@@ -95,22 +95,22 @@ impl Plugin for FxaaPlugin {
9595
render_app
9696
.init_resource::<SpecializedRenderPipelines<FxaaPipeline>>()
9797
.add_systems(Render, prepare_fxaa_pipelines.in_set(RenderSet::Prepare))
98-
.add_render_graph_node::<ViewNodeRunner<FxaaNode>>(SubGraph3d, Labels3d::Fxaa)
98+
.add_render_graph_node::<ViewNodeRunner<FxaaNode>>(Core3d, Node3d::Fxaa)
9999
.add_render_graph_edges(
100-
SubGraph3d,
100+
Core3d,
101101
(
102-
Labels3d::Tonemapping,
103-
Labels3d::Fxaa,
104-
Labels3d::EndMainPassPostProcessing,
102+
Node3d::Tonemapping,
103+
Node3d::Fxaa,
104+
Node3d::EndMainPassPostProcessing,
105105
),
106106
)
107-
.add_render_graph_node::<ViewNodeRunner<FxaaNode>>(SubGraph2d, Labels2d::Fxaa)
107+
.add_render_graph_node::<ViewNodeRunner<FxaaNode>>(Core2d, Node2d::Fxaa)
108108
.add_render_graph_edges(
109-
SubGraph2d,
109+
Core2d,
110110
(
111-
Labels2d::Tonemapping,
112-
Labels2d::Fxaa,
113-
Labels2d::EndMainPassPostProcessing,
111+
Node2d::Tonemapping,
112+
Node2d::Fxaa,
113+
Node2d::EndMainPassPostProcessing,
114114
),
115115
);
116116
}

0 commit comments

Comments
 (0)