X Tutup

vkMapMemory2(3)

Name

vkMapMemory2 - Map a memory object into application address space

C Specification

To retrieve a host virtual address pointer to a region of a mappable memory object, call:

// Provided by VK_VERSION_1_4
VkResult vkMapMemory2(
    VkDevice                                    device,
    const VkMemoryMapInfo*                      pMemoryMapInfo,
    void**                                      ppData);
// Provided by VK_KHR_map_memory2
// Equivalent to vkMapMemory2
VkResult vkMapMemory2KHR(
    VkDevice                                    device,
    const VkMemoryMapInfo*                      pMemoryMapInfo,
    void**                                      ppData);

Parameters

  • device is the logical device that owns the memory.

  • pMemoryMapInfo is a pointer to a VkMemoryMapInfo structure describing parameters of the map.

  • ppData is a pointer to a void * variable in which is returned a host-accessible pointer to the beginning of the mapped range. This pointer minus VkMemoryMapInfo::offset must be aligned to at least VkPhysicalDeviceLimits::minMemoryMapAlignment.

Description

This function behaves identically to vkMapMemory except that it gets its parameters via an extensible structure pointer rather than directly as function arguments.

Valid Usage (Implicit)

  • VUID-vkMapMemory2-device-parameter
    device must be a valid VkDevice handle

  • VUID-vkMapMemory2-pMemoryMapInfo-parameter
    pMemoryMapInfo must be a valid pointer to a valid VkMemoryMapInfo structure

  • VUID-vkMapMemory2-ppData-parameter
    ppData must be a valid pointer to a pointer value

Return Codes
Success
Failure

See Also

VK_KHR_map_memory2, VK_VERSION_1_4, VkDevice, VkMemoryMapInfo

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.

X Tutup