Magnum::Vk::RasterizationPipelineCreateInfo class new in Git master

#include <Magnum/Vk/RasterizationPipelineCreateInfo.h>

enum class Magnum::Vk::RasterizationPipelineCreateInfo::Flag: UnsignedInt

Rasterization pipeline creation flag.

Wraps the rasterization-related subset of VkPipelineCreateFlagBits.

typedef Containers::EnumSet<Flag> Magnum::Vk::RasterizationPipelineCreateInfo::Flags

Rasterization pipeline creation flags.

Type-safe wrapper for the rasterization-related subset of VkPipelineCreateFlags.

Magnum::Vk::RasterizationPipelineCreateInfo::RasterizationPipelineCreateInfo(const ShaderSet& shaderSet, const MeshLayout& meshLayout, VkPipelineLayout pipelineLayout, VkRenderPass renderPass, UnsignedInt subpass, UnsignedInt subpassColorAttachmentCount, Flags flags = {}) explicit

Constructor.

Note that the shaderSet and meshLayout structure internals are referenced, not copied, and thus have to stay in scope until the Pipeline object is created.

The following VkGraphicsPipelineCreateInfo and substructure fields are pre-filled in addition to sType of all referenced structures, everything else is zero-filled:

• flags
• stageCount and pStages to shaderSet
• pVertexInputState and pInputAssemblyState to meshLayout
• pRasterizationState
• pRasterizationState->polygonMode to VK_POLYGON_MODE_FILL
• pRasterizationState->frontFace to VK_FRONT_FACE_COUNTER_CLOCKWISE
• pRasterizationState->lineWidth to 1.0f
• pMultisampleState
• pMultisampleState->rasterizationSamples to VK_SAMPLE_COUNT_1_BIT
• pDepthStencilState
• pColorBlendState
• pColorBlendState->attachmentCount to subpassColorAttachmentCount
• pColorBlendState->pAttachments
• pColorBlendState->pAttachments[i].colorWriteMask to VK_COLOR_COMPONENT_R_BIT, VK_COLOR_COMPONENT_G_BIT, VK_COLOR_COMPONENT_B_BIT and VK_COLOR_COMPONENT_A_BIT
• layout to pipelineLayout
• renderPass
• subpass

You need to call at least setViewport() or specifying DynamicRasterizationState::Viewport in setDynamicStates() for a valid setup.

Magnum::Vk::RasterizationPipelineCreateInfo::RasterizationPipelineCreateInfo(NoInitT) explicit noexcept

Construct without initializing the contents.

Note that not even the sType field nor the nested structure pointers are set — the structure has to be fully initialized afterwards in order to be usable.

Magnum::Vk::RasterizationPipelineCreateInfo::RasterizationPipelineCreateInfo(const VkGraphicsPipelineCreateInfo& info) explicit

Construct from existing data.

Copies the existing values including the pointed-to

• VkPipelineViewportStateCreateInfo,
• VkPipelineRasterizationStateCreateInfo,
• VkPipelineMultisampleStateCreateInfo,
• VkPipelineDepthStencilStateCreateInfo,
• VkPipelineColorBlendStateCreateInfo and
• VkPipelineDynamicStateCreateInfo

structures verbatim, remaining pointers are kept unchanged without taking over the ownership. Modifying the newly created instance will not modify the original data nor the pointed-to data.

Magnum::Vk::RasterizationPipelineCreateInfo::operator const VkGraphicsPipelineCreateInfo*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

RasterizationPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::setViewport(const Range3D& viewport, const Range2Di& scissor)

Set viewport and scissor rectangle.

While the scissor rectangle is full pixels, the viewport XY range can have sub-pixel precision. The depth should be in range .

The following VkGraphicsPipelineCreateInfo and substructure fields are modified, in addition to sType of newly referenced structures:

• pViewportState
• pViewportState->viewportCount to 1
• pViewportState->pViewports[0] to viewport
• pViewportState->scissorCount to 1
• pViewportState->pScissors[0] to scissor

RasterizationPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::setViewport(const Range3D& viewport)

Set viewport with an implicit scissor rectangle.

Equivalent to calling setViewport(const Range3D&, const Range2Di&) with scissor set to the Range3D::xy() part of viewport.

RasterizationPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::setViewport(const Range2D& viewport, const Range2Di& scissor)

Set viewport with an implicit depth range.

Equivalent to calling setViewport(const Range3D&, const Range2Di&) with depth from 0.0f to 1.0f.

RasterizationPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::setViewport(const Range2D& viewport)

Set viewport with an implicit depth range and scissor rectangle.

Equivalent to calling setViewport(const Range3D&, const Range2Di&) with depth from 0.0f to 1.0f and scissor same as viewport.

RasterizationPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::setDynamicStates(const DynamicRasterizationStates& states)

Set dynamic states.

The following VkGraphicsPipelineCreateInfo and substructure fields are modified, in addition to sType of newly referenced structures:

• pDynamicState
• pDynamicState->dynamicStateCount to count of values enabled in states
• pDynamicState->pDynamicStates to a list of VkDynamicState corresponding to DynamicRasterizationState values enabled in states

const VkGraphicsPipelineCreateInfo& Magnum::Vk::RasterizationPipelineCreateInfo::operator*() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

VkGraphicsPipelineCreateInfo* Magnum::Vk::RasterizationPipelineCreateInfo::operator->()

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const VkGraphicsPipelineCreateInfo* Magnum::Vk::RasterizationPipelineCreateInfo::operator->() const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.