HoviTron Video Pipeline: VulkanPipelineAbsract Class Reference

The abstract class that encapsulate vk::Pipeline object and contains common code between the two pipelines used in this project(blending and warping). More...

#include <VulkanPipelineAbstract.h>

Inheritance diagram for VulkanPipelineAbsract:

Public Member Functions
virtual void	init ()=0

virtual void	cleanUp ()=0

void	cmdBufferBindBuffer (vk::CommandBuffer &cmdBuffer, int index, InputProvider::StreamFrameInfo &frameInfo, int view)

void	updateAllBuffer (uint32_t currentImage, int view)

void	updateBuffer (uint32_t currentImage, int view)

virtual void	createDescriptorSetLayout ()=0

uint32_t	getIndexNumber ()

Data Fields
vk::Pipeline	pipeline

vk::DescriptorSetLayout	descriptorSetLayout

vk::PipelineLayout	pipelineLayout

Protected Member Functions
virtual void	createGraphicsPipeline ()=0

vk::ShaderModule	createShaderModule (const Shader &shader)

void	createPipeline (std::vector< vk::PipelineShaderStageCreateInfo > &arr)

Protected Attributes
VulkanContext *	context = nullptr

VulkanRenderPass *	renderPass = nullptr

VulkanWrapper *	wrapper = nullptr

std::unique_ptr< BuffersController >	bufferController

int	subPass = 0

int	inputId = 0

int	colorAttachmentNb = 0

bool	depthTest = true

bool	depthWrite = true

Detailed Description

The abstract class that encapsulate vk::Pipeline object and contains common code between the two pipelines used in this project(blending and warping).

The abstract class for common code between the two pipelines (blending and warping). It encapsulates vk::Pipeline object Buffers management for the pipeline is delegated to a class that inherit from the BuffersControllerAbstract class

Definition at line 44 of file VulkanPipelineAbstract.h.

Member Function Documentation

◆ cleanUp()

virtual void VulkanPipelineAbsract::cleanUp ( )

pure virtual

Clean up

Implemented in VulkanPipelineWarping, and VulkanPipelineBlending.

◆ cmdBufferBindBuffer()

void VulkanPipelineAbsract::cmdBufferBindBuffer	(	vk::CommandBuffer &	cmdBuffer,
		int	index,
		InputProvider::StreamFrameInfo &	frameInfo,
		int	view
	)

bind the needed buffer for this frame

Definition at line 194 of file VulkanPipelineAbstract.cpp.

{
    bufferController->bindBuffers(cmdBuffer, index, frameInfo,  view);
}

◆ createDescriptorSetLayout()

virtual void VulkanPipelineAbsract::createDescriptorSetLayout ( )

pure virtual

Create descriptor sets layout

Implemented in VulkanPipelineWarping, and VulkanPipelineBlending.

◆ createGraphicsPipeline()

virtual void VulkanPipelineAbsract::createGraphicsPipeline ( )

protectedpure virtual

Create the graphics pipeline

◆ createPipeline()

void VulkanPipelineAbsract::createPipeline ( std::vector< vk::PipelineShaderStageCreateInfo > & arr )

protected

Create the pipeline

Definition at line 34 of file VulkanPipelineAbstract.cpp.

{
    auto descr = bufferController->getAttributeDescription();
    D(std::cout << "pipeline attribute descrp: " << descr.size() << std::endl;)
 
    auto descrBinding = bufferController->getBindingDescription();
 
    vk::PipelineVertexInputStateCreateInfo pipelineVertexInputStateCreateInfo(
        vk::PipelineVertexInputStateCreateFlags(),  // flags
        1,                                          // vertexBindingDescriptions Count
        &(descrBinding),              // vertexBindingDescriptions
        static_cast<uint32_t>((descr).size()), // vertexAttributeDescriptionsCount
        (descr.data())         // vertexAttributeDescriptions
    );
 
    vk::PipelineInputAssemblyStateCreateInfo pipelineInputAssemblyStateCreateInfo(
        vk::PipelineInputAssemblyStateCreateFlags(), // Flags
        vk::PrimitiveTopology::eTriangleList, // Topology
        0 // Primitive restart enable
    );
 
    
    //vk::Rect2D scissor{ {0,0},renderPass->renderingExtent };
 
    //viewport state
    vk::PipelineViewportStateCreateInfo pipelineViewportStateCreateInfo(
        vk::PipelineViewportStateCreateFlags(),
        1, &renderPass->viewport, 1, &renderPass->scissor);
 
    //rasterizer
    vk::PipelineRasterizationStateCreateInfo pipelineRasterizationStateCreateInfo(
        vk::PipelineRasterizationStateCreateFlags(),  // flags
        false,                                        // depthClampEnable
        false,                                        // rasterizerDiscardEnable
        vk::PolygonMode::eFill,                       // polygonMode
        vk::CullModeFlagBits::eNone,                  // cullMode
        vk::FrontFace::eClockwise,                    // frontFace
        false,                                        // depthBiasEnable
        0.0f,                                         // depthBiasConstantFactor
        0.0f,                                         // depthBiasClamp
        0.0f,                                         // depthBiasSlopeFactor
        1.0f                                          // lineWidth
    );
 
    vk::PipelineMultisampleStateCreateInfo pipelineMultisampleStateCreateInfo(
        vk::PipelineMultisampleStateCreateFlags(),  // flags
        vk::SampleCountFlagBits::e1                 // rasterizationSamples
                                                    // other values can be default
    );
 
    //depthStencil ?
 
    vk::PipelineDepthStencilStateCreateInfo pipelineDepthStencilStateCreateInfo(
        vk::PipelineDepthStencilStateCreateFlags(),  // flags
        true,                                        // depthTestEnable
        true,                                        // depthWriteEnable
        (! this->depthTest && depthWrite) ? vk::CompareOp::eAlways : vk::CompareOp::eLess,                 // depthCompareOp
        false,                                       // depthBoundTestEnable
        false,                                       // stencilTestEnable
        {},                              // front
        {},                               // back
        0.0f,                           //minDepthBounds
        1.0f                            //maxDepthBounds
    );
 
    //color blending
    vk::ColorComponentFlags colorComponentFlags(vk::ColorComponentFlagBits::eR | vk::ColorComponentFlagBits::eG |
        vk::ColorComponentFlagBits::eB | vk::ColorComponentFlagBits::eA);
    vk::PipelineColorBlendAttachmentState pipelineColorBlendAttachmentState(
        false,                   // blendEnable
        vk::BlendFactor::eOne,  // srcColorBlendFactor //change this for alpha blending
        vk::BlendFactor::eZero,  // dstColorBlendFactor //change this for alpha blending
        vk::BlendOp::eAdd,       // colorBlendOp
        vk::BlendFactor::eOne,  // srcAlphaBlendFactor
        vk::BlendFactor::eZero,  // dstAlphaBlendFactor
        vk::BlendOp::eAdd,       // alphaBlendOp
        colorComponentFlags      // colorWriteMask
    );
 
    //std::array<vk::PipelineColorBlendAttachmentState, 3> pipelineColorBlendAttachementArray = { pipelineColorBlendAttachmentState,pipelineColorBlendAttachmentState,pipelineColorBlendAttachmentState };
    std::vector<vk::PipelineColorBlendAttachmentState> pipelineColorBlendAttachementArray(colorAttachmentNb, pipelineColorBlendAttachmentState);
 
    vk::PipelineColorBlendStateCreateInfo pipelineColorBlendStateCreateInfo(
        vk::PipelineColorBlendStateCreateFlags(),  // flags
        false,                                     // logicOpEnable
        vk::LogicOp::eCopy,                        // logicOp  //TODO check this
        static_cast<uint32_t>(pipelineColorBlendAttachementArray.size()),
        pipelineColorBlendAttachementArray.data(),         // attachments
        { { 0.0f, 0.0f, 0.0f, 0.0f } }             // blendConstants
    );
 
    //dynamic state
    //std::array<vk::DynamicState, 2>    dynamicStates = { vk::DynamicState::eViewport, vk::DynamicState::eScissor };
    //vk::PipelineDynamicStateCreateInfo pipelineDynamicStateCreateInfo(vk::PipelineDynamicStateCreateFlags(), dynamicStates.size(), dynamicStates.data());
 
    //pipeline Layout
    vk::PipelineLayoutCreateInfo pipelineLayoutInfo(
        vk::PipelineLayoutCreateFlags(),     //flags
        1,              //layoutCount
        &descriptorSetLayout,       //pSetLayout
        0,              //pushConstantRangeCount
        nullptr);       //pushConstantRange
    pipelineLayout = context->device.createPipelineLayout(pipelineLayoutInfo);
 
    //pipelineInfo
    vk::GraphicsPipelineCreateInfo graphicsPipelineCreateInfo(
        vk::PipelineCreateFlags(),              // flags
        pipelineShaderStageCreateInfos.size(),  //stageCount
        pipelineShaderStageCreateInfos.data(),         // stages
        &pipelineVertexInputStateCreateInfo,    // pVertexInputState
        &pipelineInputAssemblyStateCreateInfo,  // pInputAssemblyState
        nullptr,                                // pTessellationState
        &pipelineViewportStateCreateInfo,       // pViewportState
        &pipelineRasterizationStateCreateInfo,  // pRasterizationState
        &pipelineMultisampleStateCreateInfo,    // pMultisampleState
        depthTest || depthWrite ? &pipelineDepthStencilStateCreateInfo : nullptr,   // pDepthStencilState
        &pipelineColorBlendStateCreateInfo,     // pColorBlendState
        nullptr,                                // pDynamicState
        pipelineLayout,                         // layout
        renderPass->renderPass,                              // renderPass
        subPass                                 //subPass
    );
 
    std::array<vk::DynamicState, 2> dynamicStates = { vk::DynamicState::eViewport, vk::DynamicState::eScissor };
    vk::PipelineDynamicStateCreateInfo dynamicInfo(
        vk::PipelineDynamicStateCreateFlags(),
        static_cast<uint32_t> (dynamicStates.size()),
        dynamicStates.data()
    );
 
    if (wrapper->isUsingDifferentViewSize() && wrapper->multiviewSetup) {
        //vk::DynamicState::eViewport
        graphicsPipelineCreateInfo.pDynamicState = &dynamicInfo;
 
    }
 
#ifdef __ANDROID__
    pipeline = context->device.createGraphicsPipeline(nullptr, graphicsPipelineCreateInfo);
#else
    vk::Result   result;
    std::tie(result, pipeline) = context->device.createGraphicsPipeline(nullptr, graphicsPipelineCreateInfo);
 
    switch (result)
    {
    case vk::Result::eSuccess: break;
    case vk::Result::ePipelineCompileRequiredEXT:
        // something meaningfull here
        throw std::runtime_error("failed to create graphics pipeline! result was ePipelineCompileRequiredEXT");
        break;
    default: throw std::runtime_error("failed to create graphics pipeline!");;  // should never happen
    }
#endif
}

◆ createShaderModule()

vk::ShaderModule VulkanPipelineAbsract::createShaderModule ( const Shader & shader )

protected

Cretae shader modules

Definition at line 22 of file VulkanPipelineAbstract.cpp.

{
    vk::ShaderModuleCreateInfo shaderModuleCreateInfo(vk::ShaderModuleCreateFlags(), shader.size, reinterpret_cast<const uint32_t*>(shader.source));
    vk::ShaderModule shaderModule = context->device.createShaderModule(shaderModuleCreateInfo);
#ifndef NDEBUG
    vk::DebugUtilsObjectNameInfoEXT debug(vk::ObjectType::eShaderModule, (uint64_t) static_cast<VkShaderModule>(shaderModule), shader.name.c_str());
    context->device.setDebugUtilsObjectNameEXT(debug);
#endif // !NDEBUG
 
    return shaderModule;
}

◆ getIndexNumber()

uint32_t VulkanPipelineAbsract::getIndexNumber ( )

Return the indices that should be drawn

Definition at line 188 of file VulkanPipelineAbstract.cpp.

{
    return bufferController->getIndiceCount();
}

◆ init()

virtual void VulkanPipelineAbsract::init ( )

pure virtual

Init process

Implemented in VulkanPipelineWarping, and VulkanPipelineBlending.

◆ updateAllBuffer()

void VulkanPipelineAbsract::updateAllBuffer	(	uint32_t	currentImage,
		int	view
	)

Update all the buffers

Definition at line 200 of file VulkanPipelineAbstract.cpp.

{
    bufferController->updateAllUniformBuffer(currentImage, view);
}

◆ updateBuffer()

void VulkanPipelineAbsract::updateBuffer	(	uint32_t	currentImage,
		int	view
	)

Update only the buffers that may have changed

Definition at line 205 of file VulkanPipelineAbstract.cpp.

{
    bufferController->updateUniformBuffer(currentImage, view);
}

Field Documentation

◆ bufferController

std::unique_ptr<BuffersController> VulkanPipelineAbsract::bufferController

protected

Pointer to the BufferController

Definition at line 79 of file VulkanPipelineAbstract.h.

◆ colorAttachmentNb

int VulkanPipelineAbsract::colorAttachmentNb = 0

protected

number of the color attachment that correspond

Definition at line 86 of file VulkanPipelineAbstract.h.

◆ context

VulkanContext* VulkanPipelineAbsract::context = nullptr

protected

Pointer to context

Definition at line 73 of file VulkanPipelineAbstract.h.

◆ depthTest

bool VulkanPipelineAbsract::depthTest = true

protected

true if depth test must be activated

Definition at line 88 of file VulkanPipelineAbstract.h.

◆ depthWrite

bool VulkanPipelineAbsract::depthWrite = true

protected

true if the depth must be written

Definition at line 90 of file VulkanPipelineAbstract.h.

◆ descriptorSetLayout

vk::DescriptorSetLayout VulkanPipelineAbsract::descriptorSetLayout

Descriptor set layoyout corresponding to this pipeline

Definition at line 65 of file VulkanPipelineAbstract.h.

◆ inputId

int VulkanPipelineAbsract::inputId = 0

protected

input camera id

Definition at line 84 of file VulkanPipelineAbstract.h.

◆ pipeline

vk::Pipeline VulkanPipelineAbsract::pipeline

vk::Pipeline object

Definition at line 63 of file VulkanPipelineAbstract.h.

◆ pipelineLayout

vk::PipelineLayout VulkanPipelineAbsract::pipelineLayout

vk::PipelineLayout corresponding to the pipeline

Definition at line 67 of file VulkanPipelineAbstract.h.

◆ renderPass

VulkanRenderPass* VulkanPipelineAbsract::renderPass = nullptr

protected

Pointer to the Vulkan render pass

Definition at line 75 of file VulkanPipelineAbstract.h.

◆ subPass

int VulkanPipelineAbsract::subPass = 0

protected

number of the subpass where this have to be executed

Definition at line 82 of file VulkanPipelineAbstract.h.

◆ wrapper

VulkanWrapper* VulkanPipelineAbsract::wrapper = nullptr

protected

Pointer to the Vulkanwrapper

Definition at line 77 of file VulkanPipelineAbstract.h.

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ cleanUp()

◆ cmdBufferBindBuffer()

◆ createDescriptorSetLayout()

◆ createGraphicsPipeline()

◆ createPipeline()

◆ createShaderModule()

◆ getIndexNumber()

◆ init()

◆ updateAllBuffer()

◆ updateBuffer()

Field Documentation

◆ bufferController

◆ colorAttachmentNb

◆ context

◆ depthTest

◆ depthWrite

◆ descriptorSetLayout

◆ inputId

◆ pipeline

◆ pipelineLayout

◆ renderPass

◆ subPass

◆ wrapper