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>
impl<'a> RenderGraphContext<'a>
sourcepub fn new(
graph: &'a RenderGraph,
node: &'a NodeState,
inputs: &'a [SlotValue],
outputs: &'a mut [Option<SlotValue>]
) -> Self
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
.
sourcepub fn input_info(&self) -> &SlotInfos
pub fn input_info(&self) -> &SlotInfos
Returns the SlotInfos
of the inputs.
sourcepub fn output_info(&self) -> &SlotInfos
pub fn output_info(&self) -> &SlotInfos
Returns the SlotInfos
of the outputs.
sourcepub fn get_input(
&self,
label: impl Into<SlotLabel>
) -> Result<&SlotValue, InputSlotError>
pub fn get_input( &self, label: impl Into<SlotLabel> ) -> Result<&SlotValue, InputSlotError>
Retrieves the input slot value referenced by the label
.
sourcepub fn get_input_texture(
&self,
label: impl Into<SlotLabel>
) -> Result<&TextureView, InputSlotError>
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
.
sourcepub fn get_input_sampler(
&self,
label: impl Into<SlotLabel>
) -> Result<&Sampler, InputSlotError>
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
.
sourcepub fn get_input_buffer(
&self,
label: impl Into<SlotLabel>
) -> Result<&Buffer, InputSlotError>
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
.
sourcepub fn get_input_entity(
&self,
label: impl Into<SlotLabel>
) -> Result<Entity, InputSlotError>
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
.
sourcepub fn set_output(
&mut self,
label: impl Into<SlotLabel>,
value: impl Into<SlotValue>
) -> Result<(), OutputSlotError>
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
.
pub fn view_entity(&self) -> Entity
pub fn get_view_entity(&self) -> Option<Entity>
pub fn set_view_entity(&mut self, view_entity: Entity)
sourcepub fn run_sub_graph(
&mut self,
name: impl RenderSubGraph,
inputs: Vec<SlotValue>,
view_entity: Option<Entity>
) -> Result<(), RunSubGraphError>
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.
sourcepub fn finish(self) -> Vec<RunSubGraph>
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, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.