# RenderGraphContext in maplibre::render::graph - Rust
The context with all graph information required to run a `Node`. This context is created for each node by the `RenderGraphRunner`.

# Struct maplibre::render::graph::RenderGraphContext

source ·

    pub struct RenderGraphContext<'a> {
        graph: &'a RenderGraph,
        node: &'a NodeState,
        inputs: &'a [SlotValue],
        outputs: &'a mut [Option<SlotValue>],
        run_sub_graphs: Vec<RunSubGraph>,
    }

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.

## Fields§

§ `graph: &'a RenderGraph` § `node: &'a NodeState` § `inputs: &'a [SlotValue]` § `outputs: &'a mut [Option<SlotValue>]` § `run_sub_graphs: Vec<RunSubGraph>`

## 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 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 run_sub_graph( &mut self, name: impl Into<Cow<'static, str>>, inputs: Vec<SlotValue> ) -> 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> !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> 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
§

### impl<T> Downcast<T> for T

§

#### fn downcast(&self) -> &T

§

### impl<T> Downcast for T
where T: Any,

§

#### 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`.
§

#### 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`.
§

#### 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.
§

#### 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> From<T> for T

source §

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### 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> Same for T

§

#### type Output = T

Should always be `Self`
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.
§

### impl<T> Upcast<T> for T

§

#### fn upcast(&self) -> Option<&T>

§

### impl<T> WithSubscriber for T

§

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

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<G1, G2> Within<G2> for G1
where G2: Contains<G1>,

§

#### fn is_within(&self, b: &G2) -> bool

source §

### impl<T> Resource for T
where T: 'static,