Vulkan-Docs/doc/specs/vulkan/man/vkGetDeviceMemoryCommitment...

64 lines
1.7 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkGetDeviceMemoryCommitment(3)
==============================
Name
----
vkGetDeviceMemoryCommitment - Query the current commitment for a VkDeviceMemory
C Specification
---------------
// refBegin 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:
include::../protos/vkGetDeviceMemoryCommitment.txt[]
Parameters
----------
* pname:device is the logical device that owns the memory.
* pname:memory is the memory object being queried.
* pname:pCommittedMemoryInBytes is a pointer to a basetype: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.
include::../validity/protos/vkGetDeviceMemoryCommitment.txt[]
See Also
--------
slink:VkDevice, slink:VkDeviceMemory, basetype: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.
include::footer.txt[]