Class PostProcessingGraphDescription
Represents the serialized description of the post-processing graph.
Namespace: Evergine.Framework.Graphics
Assembly: Evergine.Framework.dll
Syntax
public class PostProcessingGraphDescription : IdentifiableObjectConstructors
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 that 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 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 its name.
Declaration
public PostProcessingNode GetNodeByName(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the node. |
Returns
| Type | Description |
|---|---|
| PostProcessingNode | The node. |
IntegrityCheck()
Checks the graph integrity after the 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; otherwise, False. |
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). |