Skip to main content

FrameComposer

Struct FrameComposer 

Source
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.

Implementations§

Source§

impl<'a> FrameComposer<'a>

Source

pub fn device(&self) -> &Device

Returns a reference to the wgpu device.

Source

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.

Source

pub fn add_custom_pass<F>(self, stage: HookStage, hook: F) -> FrameComposer<'a>
where F: FnOnce(&mut RenderGraph<'a>, GraphBlackboard) -> GraphBlackboard + '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();
Source

pub fn render(self)

Executes the full rendering pipeline.

In windowed mode the result is presented to the swap-chain surface. In headless mode the result is written to the offscreen render target (available for readback via [Renderer::readback_pixels]).

§Architecture
  1. Acquire Render Target — swap-chain back buffer or headless texture
  2. Build RDG — register resources, wire passes (compute, shadow, scene, post-processing), invoke user hooks
  3. Compile & Execute — topological sort, allocate transients, prepare, execute, submit
  4. Present — present swap-chain (windowed only)

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more