VPP  0.7
A high-level modern C++ API for Vulkan
Public Member Functions | List of all members
vpp::Preprocess Class Reference

Represents preparation process graph node. More...

#include <vppRenderGraphNodes.hpp>

Public Member Functions

 Preprocess ()
 Constructs preprocess node for currently defined graph. More...
 
 Preprocess (RenderGraph *pGraph)
 Constructs preprocess node for specified graph. More...
 
std::uint32_t index () const
 Retrieves the index of the Preprocess node. More...
 
RenderGraphgraph () const
 Retrieves the parent render graph.
 

Detailed Description

Represents preparation process graph node.

This node performs optional preparation before rendering. It does not have any attachments, pipelines, resources nor dependencies. It has only a command sequence, supplied in the same way as for the Process node, by means of the << operator and C++ lambda function.

Commands allowed in the sequence are somewhat different kind than the ones meant to be used with Process nodes. These are so called non-rendering commands. In Vulkan specification they are being refered as executed outside render pass instance. Among these commands are mainly various clear, fill and copy commands. Also some auxiliary rendering commands may be used here: parameter and push constant setting, synchronization, image layout conversion, resource binding, pipeline selection and some others. There are no draw commands allowed, though.

This sequence is executed before any render pass.

Constructor & Destructor Documentation

◆ Preprocess() [1/2]

vpp::Preprocess::Preprocess ( )

Constructs preprocess node for currently defined graph.

Place a Preprocess node in your render graph class (derived from RenderGraph). Do not specify any arguments to the constructor. This is the recommended method of adding nodes. The constructor will automatically determine currently constructed graph instance.

◆ Preprocess() [2/2]

vpp::Preprocess::Preprocess ( RenderGraph pGraph)

Constructs preprocess node for specified graph.

Preprocess nodes can also be defined outside RenderGraph class. In such case, specify parent graph to the constructor explicitly.

Member Function Documentation

◆ index()

std::uint32_t vpp::Preprocess::index ( ) const

Retrieves the index of the Preprocess node.

Preprocess nodes have separate indexes from other types of nodes.


The documentation for this class was generated from the following file: