Struct MessageContext

A context provided to a node's Unity.DataFlowGraph.NodeDefinition.OnMessage``1(Unity.DataFlowGraph.MessageContext@,``0@) implementation which is invoked when a node receives a message on one of their MessageInputs.

Inherited Members
Namespace: Unity.DataFlowGraph
Syntax
public struct MessageContext

Properties

ArrayIndex

If the above port ID corresponds to a PortArray<TPort>, this is the array index on which the message is being received.

Declaration
public ushort ArrayIndex { get; }
Property Value
Type Description
UInt16

Handle

A handle to the node receiving a message.

Declaration
public NodeHandle Handle { get; }
Property Value
Type Description
NodeHandle

Port

The port ID of the MessageInput<TDefinition, TMsg> on which the message is being received.

Declaration
public InputPortID Port { get; }
Property Value
Type Description
InputPortID

Set

The NodeSetAPI associated with this context.

Declaration
public NodeSetAPI Set { get; }
Property Value
Type Description
NodeSetAPI

Methods

EmitMessage<T, TNodeDefinition>(MessageOutput<TNodeDefinition, T>, T)

Emit a message from yourself on a port. Everything connected to it will receive your message.

Declaration
public void EmitMessage<T, TNodeDefinition>(MessageOutput<TNodeDefinition, T> port, in T msg)
    where TNodeDefinition : NodeDefinition
Parameters
Type Name Description
MessageOutput<TNodeDefinition, T> port
T msg
Type Parameters
Name Description
T
TNodeDefinition

EmitMessage<T, TNodeDefinition>(PortArray<MessageOutput<TNodeDefinition, T>>, Int32, T)

Emit a message from yourself on a port array. Everything connected to it will receive your message.

Declaration
public void EmitMessage<T, TNodeDefinition>(PortArray<MessageOutput<TNodeDefinition, T>> port, int arrayIndex, in T msg)
    where TNodeDefinition : NodeDefinition
Parameters
Type Name Description
PortArray<MessageOutput<TNodeDefinition, T>> port
Int32 arrayIndex
T msg
Type Parameters
Name Description
T
TNodeDefinition
Exceptions
Type Condition
IndexOutOfRangeException

Thrown if the index is out of range with respect to the port array.

RegisterForUpdate()

Registers Handle for regular updates every time Update() is called. This only takes effect after the next Update(). Update(UpdateContext) RemoveFromUpdate()

Declaration
public void RegisterForUpdate()
Remarks

A node will automatically be removed from the update list when it is destroyed.

Exceptions
Type Condition
InvalidNodeDefinitionException

Will be thrown if the Handle does not support updating.
InvalidOperationException

Thrown if Handle is already registered for updating.

RemoveFromUpdate()

Deregisters Handle from updating every time Update() is called. This only takes effect after the next Update(). RegisterForUpdate()

Declaration
public void RemoveFromUpdate()
Exceptions
Type Condition
InvalidOperationException

Thrown if Handle is not registered for updating.

SetKernelBufferSize<TGraphKernel>(TGraphKernel)

Declaration
[Obsolete("Renamed to UpdateKernelBuffers (RemovedAfter 2021-01-19)")]
public void SetKernelBufferSize<TGraphKernel>(in TGraphKernel requestedSize)
    where TGraphKernel : struct, IGraphKernel
Parameters
Type Name Description
TGraphKernel requestedSize
Type Parameters
Name Description
TGraphKernel

UpdateKernelBuffers<TGraphKernel>(TGraphKernel)

Updates the contents of Buffer<T>s appearing in this node's IGraphKernel<TKernelData, TKernelPortDefinition>. Pass an instance of the node's IGraphKernel<TKernelData, TKernelPortDefinition> as the requestedContents parameter with Buffer<T> instances within it having been set using UploadRequest<T>(NativeArray<T>, BufferUploadMethod), or SizeRequest(Int32). Any Buffer<T> instances within the given struct that have default values will be unaffected by the call.

Declaration
public void UpdateKernelBuffers<TGraphKernel>(in TGraphKernel kernel)
    where TGraphKernel : struct, IGraphKernel
Parameters
Type Name Description
TGraphKernel kernel
Type Parameters
Name Description
TGraphKernel

UpdateKernelData<TKernelData>(TKernelData)

Updates the associated TKernelData asynchronously, to be available in a IGraphKernel in the next render.

Declaration
public void UpdateKernelData<TKernelData>(in TKernelData data)
    where TKernelData : struct, IKernelData
Parameters
Type Name Description
TKernelData data
Type Parameters
Name Description
TKernelData

UploadRequest<T>(NativeArray<T>, BufferUploadMethod)

The return value should be used together with UpdateKernelBuffers<TGraphKernel>(TGraphKernel) to change the contents of a kernel buffer living on a IGraphKernel<TKernelData, TKernelPortDefinition>.

Declaration
public Buffer<T> UploadRequest<T>(NativeArray<T> inputMemory, BufferUploadMethod method = BufferUploadMethod.Copy)
    where T : struct
Parameters
Type Name Description
NativeArray<T> inputMemory
BufferUploadMethod method
Returns
Type Description
Buffer<T>
Type Parameters
Name Description
T
Remarks

This will resize the affected buffer to the same size as inputMemory. Failing to include the return value in a call to UpdateKernelBuffers<TGraphKernel>(TGraphKernel) is an error and will result in a memory leak.

Operators

Implicit(MessageContext to CommonContext)

Conversion operator for common API shared with other contexts.

Declaration
public static implicit operator CommonContext(in MessageContext ctx)
Parameters
Type Name Description
MessageContext ctx
Returns
Type Description
CommonContext