C Specification

The VkMemoryMapInfo structure is defined as:

// Provided by VK_VERSION_1_4
typedef struct VkMemoryMapInfo {
    VkStructureType     sType;
    const void*         pNext;
    VkMemoryMapFlags    flags;
    VkDeviceMemory      memory;
    VkDeviceSize        offset;
    VkDeviceSize        size;
} VkMemoryMapInfo;
// Provided by VK_KHR_map_memory2
// Equivalent to VkMemoryMapInfo
typedef VkMemoryMapInfo VkMemoryMapInfoKHR;

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 VkMemoryMapFlagBits specifying additional parameters of the memory map operation.

  • memory is the VkDeviceMemory object to be mapped.

  • offset is a zero-based byte offset from the beginning of the memory object.

  • size is the size of the memory range to map, or VK_WHOLE_SIZE to map from offset to the end of the allocation.

Description

Valid Usage
Valid Usage (Implicit)

  • VUID-VkMemoryMapInfo-sType-sType
    sType must be VK_STRUCTURE_TYPE_MEMORY_MAP_INFO

  • VUID-VkMemoryMapInfo-pNext-pNext
    pNext must be NULL or a pointer to a valid instance of VkMemoryMapPlacedInfoEXT

  • VUID-VkMemoryMapInfo-sType-unique
    The sType value of each structure in the pNext chain must be unique

  • VUID-VkMemoryMapInfo-flags-parameter
    flags must be a valid combination of VkMemoryMapFlagBits values

  • VUID-VkMemoryMapInfo-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, VK_VERSION_1_4, VkDeviceMemory, VkDeviceSize, VkMemoryMapFlags, VkStructureType, vkMapMemory2, vkMapMemory2

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

SPDX-License-Identifier: CC-BY-4.0