feat(rendering): Vendor Bevy rendering crates (Phase 1 complete)
Closes #6, #7, #8, #9, #10 Refs #2, #122 Vendored bevy_render, bevy_core_pipeline, and bevy_pbr from Bevy v0.17.2 (commit 566358363126dd69f6e457e47f306c68f8041d2a) into libmarathon. - ~51K LOC vendored to crates/libmarathon/src/render/ - Merged bevy_render_macros into crates/macros/ - Fixed 773→0 compilation errors - Updated dependencies (encase 0.10→0.11, added 4 new deps) - Removed bevy_render/pbr/core_pipeline from app Cargo features All builds passing, macOS smoke test successful. Signed-off-by: Sienna Meridian Satterwhite <sienna@r3t.io>
This commit is contained in:
236
crates/libmarathon/src/render/extract_component.rs
Normal file
236
crates/libmarathon/src/render/extract_component.rs
Normal file
@@ -0,0 +1,236 @@
|
||||
use crate::render::{
|
||||
render_resource::{encase::internal::WriteInto, DynamicUniformBuffer, ShaderType},
|
||||
renderer::{RenderDevice, RenderQueue},
|
||||
sync_component::SyncComponentPlugin,
|
||||
sync_world::RenderEntity,
|
||||
Extract, ExtractSchedule, Render, RenderApp, RenderSystems,
|
||||
};
|
||||
use bevy_app::{App, Plugin};
|
||||
use bevy_camera::visibility::ViewVisibility;
|
||||
use bevy_ecs::{
|
||||
bundle::NoBundleEffect,
|
||||
component::Component,
|
||||
prelude::*,
|
||||
query::{QueryFilter, QueryItem, ReadOnlyQueryData},
|
||||
};
|
||||
use core::{marker::PhantomData, ops::Deref};
|
||||
|
||||
pub use macros::ExtractComponent;
|
||||
|
||||
/// Stores the index of a uniform inside of [`ComponentUniforms`].
|
||||
#[derive(Component)]
|
||||
pub struct DynamicUniformIndex<C: Component> {
|
||||
index: u32,
|
||||
marker: PhantomData<C>,
|
||||
}
|
||||
|
||||
impl<C: Component> DynamicUniformIndex<C> {
|
||||
#[inline]
|
||||
pub fn index(&self) -> u32 {
|
||||
self.index
|
||||
}
|
||||
}
|
||||
|
||||
/// Describes how a component gets extracted for rendering.
|
||||
///
|
||||
/// Therefore the component is transferred from the "app world" into the "render world"
|
||||
/// in the [`ExtractSchedule`] step.
|
||||
pub trait ExtractComponent: Component {
|
||||
/// ECS [`ReadOnlyQueryData`] to fetch the components to extract.
|
||||
type QueryData: ReadOnlyQueryData;
|
||||
/// Filters the entities with additional constraints.
|
||||
type QueryFilter: QueryFilter;
|
||||
|
||||
/// The output from extraction.
|
||||
///
|
||||
/// Returning `None` based on the queried item will remove the component from the entity in
|
||||
/// the render world. This can be used, for example, to conditionally extract camera settings
|
||||
/// in order to disable a rendering feature on the basis of those settings, without removing
|
||||
/// the component from the entity in the main world.
|
||||
///
|
||||
/// The output may be different from the queried component.
|
||||
/// This can be useful for example if only a subset of the fields are useful
|
||||
/// in the render world.
|
||||
///
|
||||
/// `Out` has a [`Bundle`] trait bound instead of a [`Component`] trait bound in order to allow use cases
|
||||
/// such as tuples of components as output.
|
||||
type Out: Bundle<Effect: NoBundleEffect>;
|
||||
|
||||
// TODO: https://github.com/rust-lang/rust/issues/29661
|
||||
// type Out: Component = Self;
|
||||
|
||||
/// Defines how the component is transferred into the "render world".
|
||||
fn extract_component(item: QueryItem<'_, '_, Self::QueryData>) -> Option<Self::Out>;
|
||||
}
|
||||
|
||||
/// This plugin prepares the components of the corresponding type for the GPU
|
||||
/// by transforming them into uniforms.
|
||||
///
|
||||
/// They can then be accessed from the [`ComponentUniforms`] resource.
|
||||
/// For referencing the newly created uniforms a [`DynamicUniformIndex`] is inserted
|
||||
/// for every processed entity.
|
||||
///
|
||||
/// Therefore it sets up the [`RenderSystems::Prepare`] step
|
||||
/// for the specified [`ExtractComponent`].
|
||||
pub struct UniformComponentPlugin<C>(PhantomData<fn() -> C>);
|
||||
|
||||
impl<C> Default for UniformComponentPlugin<C> {
|
||||
fn default() -> Self {
|
||||
Self(PhantomData)
|
||||
}
|
||||
}
|
||||
|
||||
impl<C: Component + ShaderType + WriteInto + Clone> Plugin for UniformComponentPlugin<C> {
|
||||
fn build(&self, app: &mut App) {
|
||||
if let Some(render_app) = app.get_sub_app_mut(RenderApp) {
|
||||
render_app
|
||||
.insert_resource(ComponentUniforms::<C>::default())
|
||||
.add_systems(
|
||||
Render,
|
||||
prepare_uniform_components::<C>.in_set(RenderSystems::PrepareResources),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Stores all uniforms of the component type.
|
||||
#[derive(Resource)]
|
||||
pub struct ComponentUniforms<C: Component + ShaderType> {
|
||||
uniforms: DynamicUniformBuffer<C>,
|
||||
}
|
||||
|
||||
impl<C: Component + ShaderType> Deref for ComponentUniforms<C> {
|
||||
type Target = DynamicUniformBuffer<C>;
|
||||
|
||||
#[inline]
|
||||
fn deref(&self) -> &Self::Target {
|
||||
&self.uniforms
|
||||
}
|
||||
}
|
||||
|
||||
impl<C: Component + ShaderType> ComponentUniforms<C> {
|
||||
#[inline]
|
||||
pub fn uniforms(&self) -> &DynamicUniformBuffer<C> {
|
||||
&self.uniforms
|
||||
}
|
||||
}
|
||||
|
||||
impl<C: Component + ShaderType> Default for ComponentUniforms<C> {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
uniforms: Default::default(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// This system prepares all components of the corresponding component type.
|
||||
/// They are transformed into uniforms and stored in the [`ComponentUniforms`] resource.
|
||||
fn prepare_uniform_components<C>(
|
||||
mut commands: Commands,
|
||||
render_device: Res<RenderDevice>,
|
||||
render_queue: Res<RenderQueue>,
|
||||
mut component_uniforms: ResMut<ComponentUniforms<C>>,
|
||||
components: Query<(Entity, &C)>,
|
||||
) where
|
||||
C: Component + ShaderType + WriteInto + Clone,
|
||||
{
|
||||
let components_iter = components.iter();
|
||||
let count = components_iter.len();
|
||||
let Some(mut writer) =
|
||||
component_uniforms
|
||||
.uniforms
|
||||
.get_writer(count, &render_device, &render_queue)
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let entities = components_iter
|
||||
.map(|(entity, component)| {
|
||||
(
|
||||
entity,
|
||||
DynamicUniformIndex::<C> {
|
||||
index: writer.write(component),
|
||||
marker: PhantomData,
|
||||
},
|
||||
)
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
commands.try_insert_batch(entities);
|
||||
}
|
||||
|
||||
/// This plugin extracts the components into the render world for synced entities.
|
||||
///
|
||||
/// To do so, it sets up the [`ExtractSchedule`] step for the specified [`ExtractComponent`].
|
||||
pub struct ExtractComponentPlugin<C, F = ()> {
|
||||
only_extract_visible: bool,
|
||||
marker: PhantomData<fn() -> (C, F)>,
|
||||
}
|
||||
|
||||
impl<C, F> Default for ExtractComponentPlugin<C, F> {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
only_extract_visible: false,
|
||||
marker: PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<C, F> ExtractComponentPlugin<C, F> {
|
||||
pub fn extract_visible() -> Self {
|
||||
Self {
|
||||
only_extract_visible: true,
|
||||
marker: PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl<C: ExtractComponent> Plugin for ExtractComponentPlugin<C> {
|
||||
fn build(&self, app: &mut App) {
|
||||
app.add_plugins(SyncComponentPlugin::<C>::default());
|
||||
|
||||
if let Some(render_app) = app.get_sub_app_mut(RenderApp) {
|
||||
if self.only_extract_visible {
|
||||
render_app.add_systems(ExtractSchedule, extract_visible_components::<C>);
|
||||
} else {
|
||||
render_app.add_systems(ExtractSchedule, extract_components::<C>);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// This system extracts all components of the corresponding [`ExtractComponent`], for entities that are synced via [`crate::sync_world::SyncToRenderWorld`].
|
||||
fn extract_components<C: ExtractComponent>(
|
||||
mut commands: Commands,
|
||||
mut previous_len: Local<usize>,
|
||||
query: Extract<Query<(RenderEntity, C::QueryData), C::QueryFilter>>,
|
||||
) {
|
||||
let mut values = Vec::with_capacity(*previous_len);
|
||||
for (entity, query_item) in &query {
|
||||
if let Some(component) = C::extract_component(query_item) {
|
||||
values.push((entity, component));
|
||||
} else {
|
||||
commands.entity(entity).remove::<C::Out>();
|
||||
}
|
||||
}
|
||||
*previous_len = values.len();
|
||||
commands.try_insert_batch(values);
|
||||
}
|
||||
|
||||
/// This system extracts all components of the corresponding [`ExtractComponent`], for entities that are visible and synced via [`crate::sync_world::SyncToRenderWorld`].
|
||||
fn extract_visible_components<C: ExtractComponent>(
|
||||
mut commands: Commands,
|
||||
mut previous_len: Local<usize>,
|
||||
query: Extract<Query<(RenderEntity, &ViewVisibility, C::QueryData), C::QueryFilter>>,
|
||||
) {
|
||||
let mut values = Vec::with_capacity(*previous_len);
|
||||
for (entity, view_visibility, query_item) in &query {
|
||||
if view_visibility.get() {
|
||||
if let Some(component) = C::extract_component(query_item) {
|
||||
values.push((entity, component));
|
||||
} else {
|
||||
commands.entity(entity).remove::<C::Out>();
|
||||
}
|
||||
}
|
||||
}
|
||||
*previous_len = values.len();
|
||||
commands.try_insert_batch(values);
|
||||
}
|
||||
Reference in New Issue
Block a user