pub struct FrameComposer<'a> { /* private fields */ }Expand description
Frame Composer
Holds all context references needed to render a single frame and provides a fluent API for injecting custom RDG passes via hooks.
§Design Notes
- Single unified graph: All rendering (scene + post + custom) flows through the RDG. No legacy graph system remains.
- Pure dataflow chain: Every
Feature::add_to_graphreturns a [TextureNodeId], enabling a strict functional pipeline where each pass’s output feeds the next pass’s input — no side-effect writes. - Flattened macro-nodes: Complex multi-step effects (e.g. Bloom) are decomposed into individual RDG passes, exposing fine-grained dependencies to the compiler for optimal barrier and memory aliasing.
- Hook-based extensibility: External code (e.g. UI) injects passes
via
add_custom_passclosures that receive theGraphBlackboardfor type-safe resource wiring. - Lifetime safety: Lifetime
'alocks the mutable borrow onRenderer. - Deferred Surface acquisition: The Surface is acquired only in
.render()to minimise hold time.
Implementations§
Source§impl<'a> FrameComposer<'a>
impl<'a> FrameComposer<'a>
Sourcepub fn resource_manager(&self) -> &ResourceManager
pub fn resource_manager(&self) -> &ResourceManager
Returns a reference to the resource manager.
Useful for user-land passes that need to resolve engine resources (e.g. texture handles) before the RDG prepare phase.
Sourcepub fn add_custom_pass<F>(self, stage: HookStage, hook: F) -> FrameComposer<'a>
pub fn add_custom_pass<F>(self, stage: HookStage, hook: F) -> FrameComposer<'a>
Registers a custom pass hook that will be invoked during graph building.
The closure receives a mutable reference to the RenderGraph and
the GraphBlackboard containing the frame’s well-known resource slots.
It must return an (optionally updated) GraphBlackboard — the Rust
type system enforces that every hook path returns a valid blackboard.
Hooks registered with HookStage::AfterPostProcess run after all
built-in post-processing (Bloom, ToneMap, FXAA) and are typically used
for UI rendering.
§Example
composer
.add_custom_pass(HookStage::AfterPostProcess, |rdg, bb| {
let new_surface = rdg.add_pass("MyPass", |builder| {
let out = builder.mutate_texture(bb.surface_out, "Surface_MyPass");
(MyPassNode { target: out }, out)
});
GraphBlackboard { surface_out: new_surface, ..bb }
})
.render();Sourcepub fn render(self)
pub fn render(self)
Executes the full rendering pipeline and presents to the screen.
§Architecture
- Acquire Surface — get the swap-chain back buffer
- Build RDG — register resources, wire passes (compute, shadow, scene, post-processing), invoke user hooks
- Compile & Execute — topological sort, allocate transients, prepare, execute, submit
- Present — present swap-chain
Consumes self; the composer cannot be reused after render.
Auto Trait Implementations§
impl<'a> Freeze for FrameComposer<'a>
impl<'a> !RefUnwindSafe for FrameComposer<'a>
impl<'a> !Send for FrameComposer<'a>
impl<'a> !Sync for FrameComposer<'a>
impl<'a> Unpin for FrameComposer<'a>
impl<'a> UnsafeUnpin for FrameComposer<'a>
impl<'a> !UnwindSafe for FrameComposer<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.