Package org.lwjgl.vulkan

Class KHRCreateRenderpass2

java.lang.Object

org.lwjgl.vulkan.KHRCreateRenderpass2

public class KHRCreateRenderpass2
extends java.lang.Object

This extension provides a new entry point to create render passes in a way that can be easily extended by other extensions through the substructures of render pass creation. The Vulkan 1.0 render pass creation sub-structures do not include sType/pNext members. Additionally, the render pass begin/next/end commands have been augmented with new extensible structures for passing additional subpass information.

The VkRenderPassMultiviewCreateInfo and VkInputAttachmentAspectReference structures that extended the original VkRenderPassCreateInfo are not accepted into the new creation functions, and instead their parameters are folded into this extension as follows:

• Elements of VkRenderPassMultiviewCreateInfo::pViewMasks are now specified in VkSubpassDescription2KHR::viewMask.
• Elements of VkRenderPassMultiviewCreateInfo::pViewOffsets are now specified in VkSubpassDependency2KHR::viewOffset.
• VkRenderPassMultiviewCreateInfo::correlationMaskCount and VkRenderPassMultiviewCreateInfo::pCorrelationMasks are directly specified in VkRenderPassCreateInfo2KHR.
• VkInputAttachmentAspectReference::aspectMask is now specified in the relevant input attachment description in VkAttachmentDescription2KHR::aspectMask

The details of these mappings are explained fully in the new structures.

Promotion to Vulkan 1.2

All functionality in this extension is included in core Vulkan 1.2, with the KHR suffix omitted. The original type, enum and command names are still available as aliases of the core functionality.

VK_KHR_create_renderpass2

Name String

VK_KHR_create_renderpass2

Extension Type

Device extension

Registered Extension Number

110

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_multiview
• Requires VK_KHR_maintenance2

Deprecation state

• Promoted to Vulkan 1.2

Contact

• Tobias Hector tobias

Other Extension Metadata

Last Modified Date

2018-02-07

Interactions and External Dependencies

• Promoted to Vulkan 1.2 Core

Contributors

• Tobias Hector
• Jeff Bolz

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VK_KHR_CREATE_RENDERPASS_2_EXTENSION_NAME	The extension name.
static int	VK_KHR_CREATE_RENDERPASS_2_SPEC_VERSION	The extension specification version.
static int	VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2_KHR VK_STRUCTURE_TYPE_SUBPASS_BEGIN_INFO_KHR VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2_KHR VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2_KHR VK_STRUCTURE_TYPE_SUBPASS_END_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdBeginRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pRenderPassBegin, long pSubpassBeginInfo)	Unsafe version of: CmdBeginRenderPass2KHR
static void	nvkCmdEndRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pSubpassEndInfo)	Unsafe version of: CmdEndRenderPass2KHR
static void	nvkCmdNextSubpass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pSubpassBeginInfo, long pSubpassEndInfo)	Unsafe version of: CmdNextSubpass2KHR
static int	nvkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device, long pCreateInfo, long pAllocator, long pRenderPass)	Unsafe version of: CreateRenderPass2KHR
static void	vkCmdBeginRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkRenderPassBeginInfo pRenderPassBegin, VkSubpassBeginInfo pSubpassBeginInfo)	See CmdBeginRenderPass2.
static void	vkCmdEndRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkSubpassEndInfo pSubpassEndInfo)	See CmdEndRenderPass2.
static void	vkCmdNextSubpass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkSubpassBeginInfo pSubpassBeginInfo, VkSubpassEndInfo pSubpassEndInfo)	See CmdNextSubpass2.
static int	vkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device, VkRenderPassCreateInfo2 pCreateInfo, VkAllocationCallbacks pAllocator, long[] pRenderPass)	Array version of: CreateRenderPass2KHR
static int	vkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device, VkRenderPassCreateInfo2 pCreateInfo, VkAllocationCallbacks pAllocator, java.nio.LongBuffer pRenderPass)	See CreateRenderPass2.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VK_KHR_CREATE_RENDERPASS_2_SPEC_VERSION

The extension specification version.

VK_KHR_CREATE_RENDERPASS_2_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR, VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR, VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2_KHR, VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2_KHR, VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2_KHR, VK_STRUCTURE_TYPE_SUBPASS_BEGIN_INFO_KHR, VK_STRUCTURE_TYPE_SUBPASS_END_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR
• STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR
• STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2_KHR
• STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2_KHR
• STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2_KHR
• STRUCTURE_TYPE_SUBPASS_BEGIN_INFO_KHR
• STRUCTURE_TYPE_SUBPASS_END_INFO_KHR

Method Detail

nvkCreateRenderPass2KHR

public static int nvkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device,
                                          long pCreateInfo,
                                          long pAllocator,
                                          long pRenderPass)

Unsafe version of: CreateRenderPass2KHR

vkCreateRenderPass2KHR

public static int vkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device,
                                         VkRenderPassCreateInfo2 pCreateInfo,
                                         @Nullable
                                         VkAllocationCallbacks pAllocator,
                                         java.nio.LongBuffer pRenderPass)

See CreateRenderPass2.

Parameters:

device - the logical device that creates the render pass.

pCreateInfo - a pointer to a VkRenderPassCreateInfo2 structure describing the parameters of the render pass.

pAllocator - controls host memory allocation as described in the Memory Allocation chapter.

pRenderPass - a pointer to a VkRenderPass handle in which the resulting render pass object is returned.

nvkCmdBeginRenderPass2KHR

public static void nvkCmdBeginRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                             long pRenderPassBegin,
                                             long pSubpassBeginInfo)

Unsafe version of: CmdBeginRenderPass2KHR

vkCmdBeginRenderPass2KHR

public static void vkCmdBeginRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                            VkRenderPassBeginInfo pRenderPassBegin,
                                            VkSubpassBeginInfo pSubpassBeginInfo)

See CmdBeginRenderPass2.

Parameters:

commandBuffer - the command buffer in which to record the command.

pRenderPassBegin - a pointer to a VkRenderPassBeginInfo structure specifying the render pass to begin an instance of, and the framebuffer the instance uses.

pSubpassBeginInfo - a pointer to a VkSubpassBeginInfo structure containing information about the subpass which is about to begin rendering.

nvkCmdNextSubpass2KHR

public static void nvkCmdNextSubpass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                         long pSubpassBeginInfo,
                                         long pSubpassEndInfo)

Unsafe version of: CmdNextSubpass2KHR

vkCmdNextSubpass2KHR

public static void vkCmdNextSubpass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                        VkSubpassBeginInfo pSubpassBeginInfo,
                                        VkSubpassEndInfo pSubpassEndInfo)

See CmdNextSubpass2.

Parameters:

commandBuffer - the command buffer in which to record the command.

pSubpassBeginInfo - a pointer to a VkSubpassBeginInfo structure containing information about the subpass which is about to begin rendering.

pSubpassEndInfo - a pointer to a VkSubpassEndInfo structure containing information about how the previous subpass will be ended.

nvkCmdEndRenderPass2KHR

public static void nvkCmdEndRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                           long pSubpassEndInfo)

Unsafe version of: CmdEndRenderPass2KHR

vkCmdEndRenderPass2KHR

public static void vkCmdEndRenderPass2KHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                          VkSubpassEndInfo pSubpassEndInfo)

See CmdEndRenderPass2.

Parameters:

commandBuffer - the command buffer in which to end the current render pass instance.

pSubpassEndInfo - a pointer to a VkSubpassEndInfo structure containing information about how the previous subpass will be ended.

vkCreateRenderPass2KHR

public static int vkCreateRenderPass2KHR(org.lwjgl.vulkan.VkDevice device,
                                         VkRenderPassCreateInfo2 pCreateInfo,
                                         @Nullable
                                         VkAllocationCallbacks pAllocator,
                                         long[] pRenderPass)

Array version of: CreateRenderPass2KHR