vkCreateRenderPass2(3)

# vkCreateRenderPass2(3) Manual Page

## Name

vkCreateRenderPass2 - Create a new render pass object

Loading… please wait.

## C Specification

To create a render pass, call:

    // Provided by VK_VERSION_1_2
    VkResult vkCreateRenderPass2(
        VkDevice                                    device,
        const VkRenderPassCreateInfo2*              pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkRenderPass*                               pRenderPass);

or the equivalent command

    // Provided by VK_KHR_create_renderpass2
    VkResult vkCreateRenderPass2KHR(
        VkDevice                                    device,
        const VkRenderPassCreateInfo2*              pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkRenderPass*                               pRenderPass);

## Parameters

- `device` is the logical device that creates the render pass.

- `pCreateInfo` is 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` is a pointer to a VkRenderPass handle in which the resulting render pass object is returned.

## Description

This command is functionally identical to vkCreateRenderPass, but includes extensible sub-structures that include `sType` and `pNext` parameters, allowing them to be more easily extended.

Valid Usage (Implicit)

- VUID-vkCreateRenderPass2-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkCreateRenderPass2-pCreateInfo-parameter
  `pCreateInfo` must be a valid pointer to a valid VkRenderPassCreateInfo2 structure

- VUID-vkCreateRenderPass2-pAllocator-parameter
  If `pAllocator` is not `NULL`, `pAllocator` must be a valid pointer to a valid VkAllocationCallbacks structure

- VUID-vkCreateRenderPass2-pRenderPass-parameter
  `pRenderPass` must be a valid pointer to a VkRenderPass handle

Return Codes

On success, this command returns

  - `VK_SUCCESS`

On failure, this command returns

  - `VK_ERROR_OUT_OF_HOST_MEMORY`

  - `VK_ERROR_OUT_OF_DEVICE_MEMORY`

## See Also

VkAllocationCallbacks, VkDevice, VkRenderPass, VkRenderPassCreateInfo2

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright 2014-2021 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0