Skip to main content

RenderGraph

Struct RenderGraph 

Source
pub struct RenderGraph {
    pub resource_table: ResourceTable,
    /* private fields */
}
Expand description

A declarative render graph: collection of passes (nodes) connected via resource dependencies (edges). Supports topological sorting, cycle detection, validation, conditional execution, and DOT export.

Fields§

§resource_table: ResourceTable

Resource table for handle bookkeeping.

Implementations§

Source§

impl RenderGraph

Source

pub fn new(label: &str) -> Self

Source

pub fn enable_feature(&mut self, feature: &str)

Source

pub fn disable_feature(&mut self, feature: &str)

Source

pub fn is_feature_enabled(&self, feature: &str) -> bool

Source

pub fn set_callback(&mut self, name: &str, value: bool)

Source

pub fn declare_resource( &mut self, descriptor: ResourceDescriptor, ) -> ResourceHandle

Declare a transient texture resource.

Source

pub fn import_resource( &mut self, descriptor: ResourceDescriptor, ) -> ResourceHandle

Declare an imported (externally managed) resource.

Source

pub fn add_pass(&mut self, pass: RenderPass)

Add a render pass to the graph.

Source

pub fn remove_pass(&mut self, name: &str) -> Option<RenderPass>

Remove a pass by name.

Source

pub fn get_pass(&self, name: &str) -> Option<&RenderPass>

Get a pass by name.

Source

pub fn get_pass_mut(&mut self, name: &str) -> Option<&mut RenderPass>

Get a mutable pass by name.

Source

pub fn pass_names(&self) -> &[String]

All pass names in insertion order.

Source

pub fn pass_count(&self) -> usize

Number of passes.

Source

pub fn resource_count(&self) -> usize

Number of resource nodes.

Source

pub fn build_edges(&mut self)

Rebuild dependency edges from resource read/write declarations.

Source

pub fn edges(&self) -> &[PassDependency]

Get all edges.

Source

pub fn detect_cycles(&mut self) -> Vec<Vec<String>>

Detect cycles in the dependency graph. Returns the set of passes involved in a cycle, or empty if acyclic.

Source

pub fn topological_sort(&mut self) -> Result<Vec<String>, Vec<String>>

Perform topological sort using Kahn’s algorithm. Returns Err with cycle participants if a cycle is detected.

Source

pub fn sorted(&mut self) -> Result<&[String], Vec<String>>

Get the sorted pass list (computes if dirty).

Source

pub fn active_passes(&mut self) -> Result<Vec<String>, Vec<String>>

Filter sorted passes to only those whose conditions are satisfied.

Source

pub fn validate(&mut self) -> ValidationResult

Validate the graph: check for cycles, dangling resources, disconnected inputs, and other structural issues.

Source

pub fn merge(&mut self, other: &RenderGraph, prefix: &str)

Merge another graph into this one. Passes and resources from other are added. Conflicting names get a prefix.

Source

pub fn export_dot(&mut self) -> String

Export the graph in Graphviz DOT format for debug visualization.

Source

pub fn label(&self) -> &str

Source

pub fn resource_node(&self, name: &str) -> Option<&ResourceNode>

Source

pub fn all_passes(&self) -> impl Iterator<Item = &RenderPass>

Source

pub fn all_resource_nodes(&self) -> impl Iterator<Item = &ResourceNode>

Source

pub fn features(&self) -> &HashSet<String>

Source

pub fn passes_by_tag(&self) -> HashMap<String, Vec<&RenderPass>>

Returns passes grouped by tag.

Trait Implementations§

Source§

impl Display for RenderGraph

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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 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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T> ToSmolStr for T
where T: Display + ?Sized,

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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> 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
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,