Struct RenderContext | Data Flow Graph | 0.16.0-preview.3
docs.unity3d.com
    Show / Hide Table of Contents

    Struct RenderContext

    Helper which is strictly only available inside a node's Execute(RenderContext, TKernelData, ref TKernelPortDefinition) implementation allowing it to resolve its data ports to actual instance data.

    Inherited Members
    ValueType.Equals(Object)
    ValueType.GetHashCode()
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.DataFlowGraph
    Syntax
    public struct RenderContext

    Methods

    Resolve<TNodeDefinition, TType>(DataInput<TNodeDefinition, TType>)

    Resolves a DataInput<TDefinition, TType> port to a readable data instance.

    Declaration
    public TType Resolve<TNodeDefinition, TType>(in DataInput<TNodeDefinition, TType> input)
        where TNodeDefinition : NodeDefinition where TType : struct
    Parameters
    Type Name Description
    DataInput<TNodeDefinition, TType> input
    Returns
    Type Description
    TType
    Type Parameters
    Name Description
    TNodeDefinition
    TType

    Resolve<TNodeDefinition, T>(DataInput<TNodeDefinition, Buffer<T>>)

    Resolves a DataInput<TDefinition, TType> port of type Buffer<T> to a read only NativeArray`1.

    Declaration
    public NativeArray<T> Resolve<TNodeDefinition, T>(in DataInput<TNodeDefinition, Buffer<T>> inputBuffer)
        where TNodeDefinition : NodeDefinition where T : struct
    Parameters
    Type Name Description
    DataInput<TNodeDefinition, Buffer<T>> inputBuffer
    Returns
    Type Description
    NativeArray<T>
    Type Parameters
    Name Description
    TNodeDefinition
    T

    Resolve<TNodeDefinition, TType>(ref DataOutput<TNodeDefinition, TType>)

    Resolves a DataOutput<TDefinition, TType> port to a writable data instance returned by reference.

    Declaration
    public TType Resolve<TNodeDefinition, TType>(ref DataOutput<TNodeDefinition, TType> output)
        where TNodeDefinition : NodeDefinition where TType : struct
    Parameters
    Type Name Description
    DataOutput<TNodeDefinition, TType> output
    Returns
    Type Description
    TType
    Type Parameters
    Name Description
    TNodeDefinition
    TType
    Remarks

    Any existing data is undefined and should be fully overwritten by a node's implementation of Execute(RenderContext, TKernelData, ref TKernelPortDefinition).

    Resolve<TNodeDefinition, T>(ref DataOutput<TNodeDefinition, Buffer<T>>)

    Resolves a DataOutput<TDefinition, TType> port of type Buffer<T> to a mutable NativeArray`1.

    Declaration
    public NativeArray<T> Resolve<TNodeDefinition, T>(ref DataOutput<TNodeDefinition, Buffer<T>> outputBuffer)
        where TNodeDefinition : NodeDefinition where T : struct
    Parameters
    Type Name Description
    DataOutput<TNodeDefinition, Buffer<T>> outputBuffer
    Returns
    Type Description
    NativeArray<T>
    Type Parameters
    Name Description
    TNodeDefinition
    T
    Remarks

    Any existing data is undefined and should be fully overwritten by a node's implementation of Execute(RenderContext, TKernelData, ref TKernelPortDefinition).

    Resolve<TDefinition, TType>(PortArray<DataInput<TDefinition, TType>>)

    Resolves a PortArray<TPort> of data inputs so that individual items in the array may be accessed.

    Declaration
    public RenderContext.ResolvedPortArray<TDefinition, TType> Resolve<TDefinition, TType>(in PortArray<DataInput<TDefinition, TType>> input)
        where TDefinition : NodeDefinition where TType : struct
    Parameters
    Type Name Description
    PortArray<DataInput<TDefinition, TType>> input
    Returns
    Type Description
    RenderContext.ResolvedPortArray<TDefinition, TType>
    Type Parameters
    Name Description
    TDefinition
    TType
    In This Article
    • Methods
      • Resolve<TNodeDefinition, TType>(DataInput<TNodeDefinition, TType>)
      • Resolve<TNodeDefinition, T>(DataInput<TNodeDefinition, Buffer<T>>)
      • Resolve<TNodeDefinition, TType>(ref DataOutput<TNodeDefinition, TType>)
      • Resolve<TNodeDefinition, T>(ref DataOutput<TNodeDefinition, Buffer<T>>)
      • Resolve<TDefinition, TType>(PortArray<DataInput<TDefinition, TType>>)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023