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

Compiled pipeline class for compute pipelines. More...

#include <vppPipeline.hpp>

Public Member Functions

 ComputePipeline ()
 Constructs null reference.
 
 ComputePipeline (VkPipeline hPipeline, const Device &hDevice)
 Constructs a pipeline object from Vulkan handle.
 
VkPipeline handle () const
 Retrieves the Vulkan handle of the pipeline.
 
void cmdBind (CommandBuffer hCmdBuffer=CommandBuffer()) const
 Generates a command to select the current pipeline. More...
 

Detailed Description

Compiled pipeline class for compute pipelines.

Represents compiled computing pipeline. Usually objects of this class are managed by ComputePass class. The ComputePass creates compiled pipelines for registered ComputePipelineLayout objects. You can then retrieve the pipeline object by index. The reason for doing so is the access to cmdBind method, which allows to select active pipeline inside the compute pass command sequence. You call this method when the computing process consists of multiple dispatch commands, using different pipelines.

Although you can also construct the ComputePipeline object directly, there is rarely any need to do this.

This object is reference counted and can be passed by value.

Member Function Documentation

◆ cmdBind()

void vpp::ComputePipeline::cmdBind ( CommandBuffer  hCmdBuffer = CommandBuffer()) const

Generates a command to select the current pipeline.

The command will be generated into specified command buffer, or the default command buffer if omitted.


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