VkExternalMemoryImageCreateInfo(3)

# VkExternalMemoryImageCreateInfo(3) Manual Page

## Name

VkExternalMemoryImageCreateInfo - Specify that an image may be backed by external memory

Loading… please wait.

## C Specification

To define a set of external memory handle types that may be used as backing store for an image, add a VkExternalMemoryImageCreateInfo structure to the `pNext` chain of the VkImageCreateInfo structure. The `VkExternalMemoryImageCreateInfo` structure is defined as:

    // Provided by VK_VERSION_1_1
    typedef struct VkExternalMemoryImageCreateInfo {
        VkStructureType                    sType;
        const void*                        pNext;
        VkExternalMemoryHandleTypeFlags    handleTypes;
    } VkExternalMemoryImageCreateInfo;

or the equivalent

    // Provided by VK_KHR_external_memory
    typedef VkExternalMemoryImageCreateInfo VkExternalMemoryImageCreateInfoKHR;

## Members

| Note A `VkExternalMemoryImageCreateInfo` structure must be included in the creation parameters for an image that will be bound to memory that is either exported or imported.

## Description

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `handleTypes` is a bitmask of VkExternalMemoryHandleTypeFlagBits specifying one or more external memory handle types.

Valid Usage (Implicit)

- VUID-VkExternalMemoryImageCreateInfo-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_IMAGE_CREATE_INFO`

- VUID-VkExternalMemoryImageCreateInfo-handleTypes-parameter
  `handleTypes` must be a valid combination of VkExternalMemoryHandleTypeFlagBits values

- VUID-VkExternalMemoryImageCreateInfo-handleTypes-requiredbitmask
  `handleTypes` must not be `0`

## See Also

VkExternalMemoryHandleTypeFlags, VkStructureType

## 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 (c) 2014-2020 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0