C Specification

The VkMemoryUnmapInfoKHR structure is defined as:

// Provided by VK_KHR_map_memory2
typedef struct VkMemoryUnmapInfoKHR {
    VkStructureType          sType;
    const void*              pNext;
    VkMemoryUnmapFlagsKHR    flags;
    VkDeviceMemory           memory;
} 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 VkMemoryUnmapFlagBitsKHR specifying additional parameters of the memory map operation.

  • memory is the VkDeviceMemory object to be unmapped.

Description

Valid Usage

  • VUID-VkMemoryUnmapInfoKHR-memory-07964
    memory must be currently host mapped

  • VUID-VkMemoryUnmapInfoKHR-flags-09579
    If VK_MEMORY_UNMAP_RESERVE_BIT_EXT is set in flags, the memoryUnmapReserve must be enabled

  • VUID-VkMemoryUnmapInfoKHR-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-VkMemoryUnmapInfoKHR-sType-sType
    sType must be VK_STRUCTURE_TYPE_MEMORY_UNMAP_INFO_KHR

  • VUID-VkMemoryUnmapInfoKHR-pNext-pNext
    pNext must be NULL

  • VUID-VkMemoryUnmapInfoKHR-flags-parameter
    flags must be a valid combination of VkMemoryUnmapFlagBitsKHR values

  • VUID-VkMemoryUnmapInfoKHR-memory-parameter
    memory must be a valid VkDeviceMemory handle

Host Synchronization

  • Host access to memory must be externally synchronized

See Also

VK_KHR_map_memory2, VkDeviceMemory, VkMemoryUnmapFlagsKHR, VkStructureType, vkUnmapMemory2KHR

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

SPDX-License-Identifier: CC-BY-4.0