Struct bevy_render::render_graph::RenderGraphContext

source ·
pub struct RenderGraphContext<'a> { /* private fields */ }
Expand description

The context with all graph information required to run a Node. This context is created for each node by the RenderGraphRunner.

The slot input can be read from here and the outputs must be written back to the context for passing them onto the next node.

Sub graphs can be queued for running by adding a RunSubGraph command to the context. After the node has finished running the graph runner is responsible for executing the sub graphs.

Implementations§

source§

impl<'a> RenderGraphContext<'a>

source

pub fn new( graph: &'a RenderGraph, node: &'a NodeState, inputs: &'a [SlotValue], outputs: &'a mut [Option<SlotValue>] ) -> Self

Creates a new render graph context for the node.

source

pub fn inputs(&self) -> &[SlotValue]

Returns the input slot values for the node.

source

pub fn input_info(&self) -> &SlotInfos

Returns the SlotInfos of the inputs.

source

pub fn output_info(&self) -> &SlotInfos

Returns the SlotInfos of the outputs.

source

pub fn get_input( &self, label: impl Into<SlotLabel> ) -> Result<&SlotValue, InputSlotError>

Retrieves the input slot value referenced by the label.

source

pub fn get_input_texture( &self, label: impl Into<SlotLabel> ) -> Result<&TextureView, InputSlotError>

Retrieves the input slot value referenced by the label as a TextureView.

source

pub fn get_input_sampler( &self, label: impl Into<SlotLabel> ) -> Result<&Sampler, InputSlotError>

Retrieves the input slot value referenced by the label as a Sampler.

source

pub fn get_input_buffer( &self, label: impl Into<SlotLabel> ) -> Result<&Buffer, InputSlotError>

Retrieves the input slot value referenced by the label as a Buffer.

source

pub fn get_input_entity( &self, label: impl Into<SlotLabel> ) -> Result<Entity, InputSlotError>

Retrieves the input slot value referenced by the label as an Entity.

source

pub fn set_output( &mut self, label: impl Into<SlotLabel>, value: impl Into<SlotValue> ) -> Result<(), OutputSlotError>

Sets the output slot value referenced by the label.

source

pub fn view_entity(&self) -> Entity

source

pub fn get_view_entity(&self) -> Option<Entity>

source

pub fn set_view_entity(&mut self, view_entity: Entity)

source

pub fn run_sub_graph( &mut self, name: impl RenderSubGraph, inputs: Vec<SlotValue>, view_entity: Option<Entity> ) -> Result<(), RunSubGraphError>

Queues up a sub graph for execution after the node has finished running.

source

pub fn finish(self) -> Vec<RunSubGraph>

Finishes the context for this Node by returning the sub graphs to run next.

Auto Trait Implementations§

§

impl<'a> Freeze for RenderGraphContext<'a>

§

impl<'a> !RefUnwindSafe for RenderGraphContext<'a>

§

impl<'a> Send for RenderGraphContext<'a>

§

impl<'a> Sync for RenderGraphContext<'a>

§

impl<'a> Unpin for RenderGraphContext<'a>

§

impl<'a> !UnwindSafe for RenderGraphContext<'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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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> 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<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> TryFrom<U> for T
where U: Into<T>,

§

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

§

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
source§

impl<T> ConditionalSend for T
where T: Send,

source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,