Vulkan-Docs/doc/specs/vulkan/man/VkMemoryHeap.txt

63 lines
1.5 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/
VkMemoryHeap(3)
===============
Name
----
VkMemoryHeap - Structure specifying a memory heap
C Specification
---------------
// refBegin VkMemoryHeap - Structure specifying a memory heap
The sname:VkMemoryHeap structure is defined as:
include::../structs/VkMemoryHeap.txt[]
Members
-------
* pname:size is the total memory size in bytes in the heap.
* pname:flags is a bitmask of attribute flags for the heap. The bits
specified in pname:flags are:
+
--
// refBegin VkMemoryHeapFlagBits - Bitmask specifying attribute flags for a heap
include::../enums/VkMemoryHeapFlagBits.txt[]
--
** if pname:flags contains ename:VK_MEMORY_HEAP_DEVICE_LOCAL_BIT, it means
the heap corresponds to device local memory. Device local memory may:
have different performance characteristics than host local memory, and
may: support different memory property flags.
Description
-----------
include::../validity/structs/VkMemoryHeap.txt[]
See Also
--------
basetype:VkDeviceSize, elink:VkMemoryHeapFlags, slink:VkPhysicalDeviceMemoryProperties
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkMemoryHeap
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]