Function Prototype

vkGetDeviceMemoryCommitment

Query the current commitment for a VkDeviceMemory

To determine the amount of lazily-allocated memory that is currently committed for a memory object, call:

void vkGetDeviceMemoryCommitment(
    VkDevice device,
    VkDeviceMemory memory,
    VkDeviceSize* pCommittedMemoryInBytes);
  • device is the logical device that owns the memory.
  • memory is the memory object being queried.
  • pCommittedMemoryInBytes is a pointer to a VkDeviceSize value in which the number of bytes currently committed is returned, on success.

The implementation may update the commitment at any time, and the value returned by this query may be out of date.

The implementation guarantees to allocate any committed memory from the heapIndex indicated by the memory type that the memory object was created with.

Valid Usage

VUID-vkGetDeviceMemoryCommitment-memory-00690

memory must have been created with a memory type that reports VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT

Valid Usage (Implicit)

VUID-vkGetDeviceMemoryCommitment-pCommittedMemoryInBytes-parameter

pCommittedMemoryInBytes must be a valid pointer to a VkDeviceSize value

VUID-vkGetDeviceMemoryCommitment-memory-parent

memory must have been created, allocated, or retrieved from device