Class CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>

Inheritance

Object

NodeDefinition

SimulationNodeDefinition<TSimPorts>

SimulationKernelNodeDefinition<TSimPorts, TKernelPorts>

Unity.DataFlowGraph.NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>

CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>

AnimationCompositorNodeDefinition

ConversionServiceTests.DummyCompositorNodeDefinition

Inherited Members

Unity.DataFlowGraph.NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>.GetNodeData(Unity.DataFlowGraph.NodeHandle)

Unity.DataFlowGraph.NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>.GetKernelData(Unity.DataFlowGraph.NodeHandle)

SimulationKernelNodeDefinition<TSimPorts, TKernelPorts>.KernelPorts

SimulationNodeDefinition<TSimPorts>.SimulationPorts

Unity.DataFlowGraph.NodeDefinition.VirtualTable

NodeDefinition.OnUpdate(UpdateContext)

NodeDefinition.Dispose()

NodeDefinition.GetStaticPortDescription()

NodeDefinition.GetPortDescription(NodeHandle)

NodeDefinition.EmitMessage<T, TNodeDefinition>(NodeHandle, MessageOutput<TNodeDefinition, T>, T)

NodeDefinition.Set

Unity.DataFlowGraph.NodeDefinition.BaseTraits

Unity.DataFlowGraph.NodeDefinition.SimulationStorageTraits

Unity.DataFlowGraph.NodeDefinition.KernelStorageTraits

NodeDefinition.HasStaticPortDescription

Namespace: Unity.Compositor

Syntax

public abstract class CompositorNodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel> : NodeDefinition<TSimData, TSimPorts, TKernelData, TKernelPorts, TKernel>, IGraphHandler, ITaskPortMsgHandler<IGraphHandler, BlobAssetReference<Graph>>, ITaskPort<IGraphHandler>, IGraphInstanceHandler, ITaskPortMsgHandler<IGraphInstanceHandler, BlobAssetReference<GraphInstanceParameters>>, ITaskPort<IGraphInstanceHandler>, IMsgHandler<BlobAssetReference<GraphInstanceParameters>>, IEntityContextHandler, ITaskPortMsgHandler<IEntityContextHandler, EntityContext>, ITaskPort<IEntityContextHandler>, IMsgHandler<EntityContext>, IComponentNodeHandler, ITaskPortMsgHandler<IComponentNodeHandler, NodeHandle<ComponentNode>>, ITaskPort<IComponentNodeHandler>, IMsgHandler<NodeHandle<ComponentNode>>, IMsgHandler<BlobAssetReference<Graph>>, IGraphSlot<TSimData> where TSimData : struct, INodeData, ICompositorRootSimulationData where TSimPorts : struct, ISimulationPortDefinition where TKernelData : struct, IKernelData where TKernelPorts : struct, IKernelPortDefinition where TKernel : struct, IGraphKernel<TKernelData, TKernelPorts>

Type Parameters

Name	Description
TSimData
TSimPorts
TKernelData
TKernelPorts
TKernel

Methods

AddNode(ref TSimData, CreateNodeCommand)

Declaration

public void AddNode(ref TSimData data, CreateNodeCommand create)

Parameters

Type	Name	Description
TSimData	data
CreateNodeCommand	create

Implements

IGraphSlot<TNodeData>.AddNode(ref TNodeData, CreateNodeCommand)

Destroy(DestroyContext)

Declaration

protected override void Destroy(DestroyContext ctx)

Parameters

Type	Name	Description
DestroyContext	ctx

Overrides

NodeDefinition.Destroy(DestroyContext)

GetComponentNodePort(NodeHandle)

Declaration

protected abstract InputPortID GetComponentNodePort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

GetEntityContextPort(NodeHandle)

Declaration

public abstract InputPortID GetEntityContextPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

GetGraphInstancePort(NodeHandle)

Declaration

protected abstract InputPortID GetGraphInstancePort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

GetGraphPort(NodeHandle)

Declaration

protected abstract InputPortID GetGraphPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

GetInputPort(ref TSimData, CompositorNodeID, CompositorPortID)

Declaration

public PortDescription.InputPort GetInputPort(ref TSimData data, CompositorNodeID Node, CompositorPortID Port)

Parameters

Type	Name	Description
TSimData	data
CompositorNodeID	Node
CompositorPortID	Port

Returns

Type	Description
PortDescription.InputPort

Implements

IGraphSlot<TNodeData>.GetInputPort(ref TNodeData, CompositorNodeID, CompositorPortID)

GetOutputPort(ref TSimData, CompositorNodeID, CompositorPortID)

Declaration

public PortDescription.OutputPort GetOutputPort(ref TSimData data, CompositorNodeID Node, CompositorPortID Port)

Parameters

Type	Name	Description
TSimData	data
CompositorNodeID	Node
CompositorPortID	Port

Returns

Type	Description
PortDescription.OutputPort

Implements

IGraphSlot<TNodeData>.GetOutputPort(ref TNodeData, CompositorNodeID, CompositorPortID)

GetPort(NodeHandle)

Declaration

public InputPortID GetPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

Implements

ITaskPort<TTask>.GetPort(NodeHandle)

HandleMessage(MessageContext, EntityContext)

Declaration

public void HandleMessage(in MessageContext ctx, in EntityContext msg)

Parameters

Type	Name	Description
MessageContext	ctx
EntityContext	msg

Implements

IMsgHandler<TMsg>.HandleMessage(MessageContext, TMsg)

HandleMessage(MessageContext, NodeHandle<ComponentNode>)

Declaration

public void HandleMessage(in MessageContext ctx, in NodeHandle<ComponentNode> msg)

Parameters

Type	Name	Description
MessageContext	ctx
NodeHandle<ComponentNode>	msg

Implements

IMsgHandler<TMsg>.HandleMessage(MessageContext, TMsg)

HandleMessage(MessageContext, BlobAssetReference<Graph>)

Declaration

public virtual void HandleMessage(in MessageContext ctx, in BlobAssetReference<Graph> graph)

Parameters

Type	Name	Description
MessageContext	ctx
BlobAssetReference<Graph>	graph

Implements

IMsgHandler<TMsg>.HandleMessage(MessageContext, TMsg)

HandleMessage(MessageContext, BlobAssetReference<GraphInstanceParameters>)

Declaration

public virtual void HandleMessage(in MessageContext ctx, in BlobAssetReference<GraphInstanceParameters> msg)

Parameters

Type	Name	Description
MessageContext	ctx
BlobAssetReference<GraphInstanceParameters>	msg

Implements

IMsgHandler<TMsg>.HandleMessage(MessageContext, TMsg)

Init(InitContext)

Declaration

protected override void Init(InitContext ctx)

Parameters

Type	Name	Description
InitContext	ctx

Overrides

NodeDefinition.Init(InitContext)

SendMessage<TMsg, TValue>(NodeHandle, TMsg)

Declaration

protected void SendMessage<TMsg, TValue>(NodeHandle handle, TMsg message)
    where TMsg : struct, ICompositorTarget<TValue> where TValue : struct

Parameters

Type	Name	Description
NodeHandle	handle
TMsg	message

Type Parameters

Name	Description
TMsg
TValue

SendMessages<TMsg, TValue>(NodeHandle, DynamicBuffer<TMsg>)

Declaration

protected void SendMessages<TMsg, TValue>(NodeHandle handle, DynamicBuffer<TMsg> messages)
    where TMsg : struct, ICompositorTarget<TValue> where TValue : struct

Parameters

Type	Name	Description
NodeHandle	handle
DynamicBuffer<TMsg>	messages

Type Parameters

Name	Description
TMsg
TValue

Explicit Interface Implementations

ITaskPort<IComponentNodeHandler>.GetPort(NodeHandle)

Declaration

InputPortID ITaskPort<IComponentNodeHandler>.GetPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

Implements

ITaskPort<TTask>.GetPort(NodeHandle)

ITaskPort<IGraphHandler>.GetPort(NodeHandle)

Declaration

InputPortID ITaskPort<IGraphHandler>.GetPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

Implements

ITaskPort<TTask>.GetPort(NodeHandle)

ITaskPort<IGraphInstanceHandler>.GetPort(NodeHandle)

Declaration

InputPortID ITaskPort<IGraphInstanceHandler>.GetPort(NodeHandle handle)

Parameters

Type	Name	Description
NodeHandle	handle

Returns

Type	Description
InputPortID

Implements

ITaskPort<TTask>.GetPort(NodeHandle)