Struct amethyst_rendy::bundle::TargetPlanContext

pub struct TargetPlanContext<'a, B: Backend> { /* fields omitted */ }

A planning context focused on specific render target.

Methods

impl<'a, B: Backend> TargetPlanContext<'a, B>

pub fn add(
    &mut self,
    order: impl Into<i32>,
    action: impl IntoAction<B>
) -> Result<(), Error>

Add new action to render target in defined order.

pub fn colors(&self) -> usize

Get number of color outputs of current render target.

pub fn depth(&self) -> bool

Check if current render target has a depth output.

pub fn get_image(&mut self, image: TargetImage) -> Result<ImageId, Error>

Retrieve an image produced by other render target.

Results in an error if such image doesn't exist or retreiving it would result in a dependency cycle.

pub fn try_get_image(
    &mut self,
    image: TargetImage
) -> Result<Option<ImageId>, Error>

Retrieve an image produced by other render target. Returns None when such image isn't registered.

Results in an error if retreiving it would result in a dependency cycle.

pub fn add_dep(&mut self, node: NodeId)

Add explicit dependency on another node.

This is done automatically when you use get_image.

pub fn graph(&mut self) -> &mut GraphBuilder<B, World>

Access underlying rendy's GraphBuilder directly. This is useful for adding custom rendering nodes that are not just standard graphics render passes, e.g. for compute dispatch.

pub fn target_metadata(&self, target: Target) -> Option<TargetMetadata>

Retrieve render target metadata, e.g. size.

pub fn get_node(&mut self, target: Target) -> Result<NodeId, Error>

Access computed NodeId of render target.

Trait Implementations

impl<'a, B: Debug + Backend> Debug for TargetPlanContext<'a, B>

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

Formats the value using the given formatter.