VkMemoryUnmapInfo(3)

Name

VkMemoryUnmapInfo - Structure containing parameters of a memory unmap operation

C Specification

The VkMemoryUnmapInfo structure is defined as:

// Provided by VK_VERSION_1_4
typedef struct VkMemoryUnmapInfo {
    VkStructureType       sType;
    const void*           pNext;
    VkMemoryUnmapFlags    flags;
    VkDeviceMemory        memory;
} VkMemoryUnmapInfo;

// Provided by VK_KHR_map_memory2
// Equivalent to VkMemoryUnmapInfo
typedef VkMemoryUnmapInfo VkMemoryUnmapInfoKHR;

Members

sType is a VkStructureType value identifying this structure.
pNext is NULL or a pointer to a structure extending this structure.
flags is a bitmask of VkMemoryUnmapFlagBits specifying additional parameters of the memory map operation.
memory is the VkDeviceMemory object to be unmapped.

Description

Valid Usage

VUID-VkMemoryUnmapInfo-memory-07964
memory must be currently host mapped
VUID-VkMemoryUnmapInfo-flags-09579
If VK_MEMORY_UNMAP_RESERVE_BIT_EXT is set in flags, the memoryUnmapReserve must be enabled
VUID-VkMemoryUnmapInfo-flags-09580
If VK_MEMORY_UNMAP_RESERVE_BIT_EXT is set in flags, the memory object must not have been imported from a handle type of VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION_BIT_EXT or VK_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_MAPPED_FOREIGN_MEMORY_BIT_EXT

Valid Usage (Implicit)

VUID-VkMemoryUnmapInfo-sType-sType
sType must be VK_STRUCTURE_TYPE_MEMORY_UNMAP_INFO
VUID-VkMemoryUnmapInfo-pNext-pNext
pNext must be NULL
VUID-VkMemoryUnmapInfo-flags-parameter
flags must be a valid combination of VkMemoryUnmapFlagBits values
VUID-VkMemoryUnmapInfo-memory-parameter
memory must be a valid VkDeviceMemory handle

Host Synchronization

Host access to memory must be externally synchronized

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.