vkCreateRenderPass(3)

# vkCreateRenderPass(3) Manual Page

## Name

vkCreateRenderPass - Create a new render pass object

Loading… please wait.

## C Specification

To create a render pass, call:

    // Provided by VK_VERSION_1_0
    VkResult vkCreateRenderPass(
        VkDevice                                    device,
        const VkRenderPassCreateInfo*               pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkRenderPass*                               pRenderPass);

## Parameters

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

- `pCreateInfo` is a pointer to a VkRenderPassCreateInfo 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

Valid Usage (Implicit)

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

- VUID-vkCreateRenderPass-pCreateInfo-parameter
  `pCreateInfo` must be a valid pointer to a valid VkRenderPassCreateInfo structure

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

- VUID-vkCreateRenderPass-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

VK_VERSION_1_0, VkAllocationCallbacks, VkDevice, VkRenderPass, VkRenderPassCreateInfo

## 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-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0