Class OutputPortAttribute

The attributes for node output ports.

Inheritance

Object

Attribute

OutputPortAttribute

Namespace: Unity.VisualCompositor

Syntax

[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field)]
public class OutputPortAttribute : Attribute, _Attribute, IHasOrder, IHasName

Constructors

OutputPortAttribute(Int32, String, Boolean)

Add an output port to a node.

Declaration

public OutputPortAttribute(int order = 0, string name = null, bool showOutputPreview = true)

Parameters

Type	Name	Description
Int32	order	The order of the port
String	name	The name of the port
Boolean	showOutputPreview	Should the output of this port be visualised?

Methods

GetName()

Returns the name of the object

Declaration

public string GetName()

Returns

Type	Description
String	The name as string

Implements

IHasName.GetName()

GetOrder()

Gets the order

Declaration

public int GetOrder()

Returns

Type	Description
Int32	The order

Implements

IHasOrder.GetOrder()

ShowOutputPreview()

Returns whether the port should show output preview.

Declaration

public bool ShowOutputPreview()

Returns

Type	Description
Boolean	true if the output of this port should be visualised, false otherwise