VKGETDEVICEMEMORYCOM(3)

NAME
vkGetDeviceMemoryCommitment - Query the current commitment for a VkDeviceMemory

C SPECIFICATION

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);

PARAMETERS

    • 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.

DESCRIPTION

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

    • device must be a valid VkDevice handle

    • memory must be a valid VkDeviceMemory handle

    • pCommittedMemoryInBytes must be a pointer to a VkDeviceSize value

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

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

SEE ALSO

VkDevice, VkDeviceMemory, VkDeviceSize

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkGetDeviceMemoryCommitment

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.