Class PostProcessingGraphDescription
Represents the post-processing graph serialized description.
Inherited Members
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public class PostProcessingGraphDescription : IdentifiableObject
Constructors
PostProcessingGraphDescription()
Initializes a new instance of the PostProcessingGraphDescription class.
Declaration
public PostProcessingGraphDescription()
PostProcessingGraphDescription(RenderPath, bool)
Initializes a new instance of the PostProcessingGraphDescription class.
Declaration
public PostProcessingGraphDescription(RenderPath renderPath, bool startConnectedToEnd = true)
Parameters
Type | Name | Description |
---|---|---|
RenderPath | renderPath | The render path instance. |
bool | startConnectedToEnd | Indicates the startNode will have a connection with the endNode. |
Properties
EndNode
Gets or sets the final node.
Declaration
[EvergineMember(2)]
public PostProcessingNode EndNode { get; set; }
Property Value
Type | Description |
---|---|
PostProcessingNode |
Nodes
Gets or sets represents a single post-processing task.
Declaration
[EvergineMember(3)]
public List<PostProcessingNode> Nodes { get; set; }
Property Value
Type | Description |
---|---|
List<PostProcessingNode> |
StartNode
Gets or sets the initial node.
Declaration
[EvergineMember(1)]
public PostProcessingNode StartNode { get; set; }
Property Value
Type | Description |
---|---|
PostProcessingNode |
Methods
AddNode(PostProcessingNode)
Adds a new Post-Processing Node to the Graph.
Declaration
public PostProcessingGraphDescription AddNode(PostProcessingNode node)
Parameters
Type | Name | Description |
---|---|---|
PostProcessingNode | node | The new node. |
Returns
Type | Description |
---|---|
PostProcessingGraphDescription | The post-processing Graph (fluent syntax). |
GetNodeByID(Guid)
Gets the node by a node id.
Declaration
public PostProcessingNode GetNodeByID(Guid nodeId)
Parameters
Type | Name | Description |
---|---|---|
Guid | nodeId | The node id. |
Returns
Type | Description |
---|---|
PostProcessingNode | The node. |
GetNodeByName(string)
Gets the node by a node name.
Declaration
public PostProcessingNode GetNodeByName(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The node name. |
Returns
Type | Description |
---|---|
PostProcessingNode | The node. |
IntegrityCheck()
Check the graph integrity after serialization process.
Declaration
public void IntegrityCheck()
IsValid()
Indicates whether the graph has a path from the startNode to endNode.
Declaration
public bool IsValid()
Returns
Type | Description |
---|---|
bool | True if there is a path from the startNode to endNode or False in otherwise. |
RemoveNode(PostProcessingNode)
Removes a post-processing Node from the Graph.
Declaration
public PostProcessingGraphDescription RemoveNode(PostProcessingNode node)
Parameters
Type | Name | Description |
---|---|---|
PostProcessingNode | node | The node. |
Returns
Type | Description |
---|---|
PostProcessingGraphDescription | The post-processing Graph (fluent syntax). |