Struct shadergraph::graph::ShaderGraph

pub struct ShaderGraph {
    pub created: Instant,
    // some fields omitted
}

Represents a Directed Acyclic Graph of shaders. Each shader is run sequentially, and can be the input to shaders later down the line.

Fields

created: Instant

Implementations

impl ShaderGraph

pub fn new(context: &Rc<Context>) -> ShaderGraph

Creates a new shader graph within a specific glium context.

pub fn get_inputs(&self) -> &Vec<NodeId>

pub fn get_outputs(&self) -> &Vec<NodeId>

pub fn add_node(&mut self, node: Option<Box<dyn Node>>) -> NodeId

Adds anything that implements the Node trait to the graph Will panic if the Node does not preserve DAG structure.

pub fn add_input(&mut self) -> NodeId

Adds an input to the shader graph. Use the returned NodeId to mark it as a texture input to other shaders.

pub fn add_shader(
    &mut self,
    source: &str,
    inputs: Vec<NodeId>,
    width: u32,
    height: u32
) -> Result<NodeId, String>

Adds a shader to a shader graph. Each shader has its own underlying Texture2d of a particular size. Shader is bound to the graph’s context.

pub fn add_rec_shader(
    &mut self,
    source: &str,
    inputs: Vec<NodeId>,
    width: u32,
    height: u32
) -> Result<NodeId, String>

Add a recurrent shader to the graph.

pub fn add_compute<T: AsUniformValue + 'static>(
    &mut self,
    compute_node: ComputeNode<T>
) -> Result<NodeId, String>

Adds a compute node, which produces a set of uniforms for use in the next shader.

pub fn mark_output(&mut self, id: NodeId) -> Option<NodeId>

Mark a node in the graph as an output. When calling forward, this node’s texture will be included in the output map. To access it, index the map with the NodeId this method returns. Returns None if the requested Node does not support being an output.

pub fn forward<'a>(
    &'a mut self,
    input_map: BTreeMap<NodeId, &'a Texture2d>
) -> BTreeMap<NodeId, &'a Texture2d>

Does a forward pass of the entire shader graph. Takes a set of N inputs, and produces a set of M outputs. Each shader in the DAG is run, from front to back, previous input textures are bound as uniforms of the form: u_texture_0, .., u_texture_n. Use the map! macro to quickly build a BTreeMap to pass to this function. All marked outputs will be included in the output map.

Trait Implementations

impl Debug for ShaderGraph

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

Formats the value using the given formatter.