2017-06-20 09:17:23 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.13" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > Vulkan Memory Allocator: General< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > Vulkan Memory Allocator
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Classes< / a > |
< a href = "#define-members" > Macros< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
2017-07-11 13:22:12 +00:00
< a href = "#enum-members" > Enumerations< / a > |
2017-06-20 09:17:23 +00:00
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > General< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Classes< / h2 > < / td > < / tr >
2017-07-11 13:22:12 +00:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_device_memory_callbacks.html" > VmaDeviceMemoryCallbacks< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory. < a href = "struct_vma_device_memory_callbacks.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-22 14:57:38 +00:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_vulkan_functions.html" > VmaVulkanFunctions< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-20 09:17:23 +00:00
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Description of a Allocator to be created. < a href = "struct_vma_allocator_create_info.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_stat_info.html" > VmaStatInfo< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a > < / td > < / tr >
< tr class = "memdesc:" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > General statistics from current state of Allocator. < a href = "struct_vma_stats.html#details" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
< tr class = "memitem:gae25f0d55fd91cb166f002b63244800e1" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gae25f0d55fd91cb166f002b63244800e1" > VMA_STATS_STRING_ENABLED< / a >       1< / td > < / tr >
< tr class = "separator:gae25f0d55fd91cb166f002b63244800e1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
2017-07-11 13:22:12 +00:00
< tr class = "memitem:gab6a6477cda1ce775b30bde96d766203b" > < td class = "memItemLeft" align = "right" valign = "top" > typedef void(VKAPI_PTR *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gab6a6477cda1ce775b30bde96d766203b" > PFN_vmaAllocateDeviceMemoryFunction< / a > ) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)< / td > < / tr >
< tr class = "memdesc:gab6a6477cda1ce775b30bde96d766203b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function called after successful vkAllocateMemory. < a href = "#gab6a6477cda1ce775b30bde96d766203b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gab6a6477cda1ce775b30bde96d766203b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > < td class = "memItemLeft" align = "right" valign = "top" > typedef void(VKAPI_PTR *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > PFN_vmaFreeDeviceMemoryFunction< / a > ) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)< / td > < / tr >
< tr class = "memdesc:gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Callback function called before vkFreeMemory. < a href = "#gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga5e2eb68d727cfd4df25702b027b7aa31" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_vma_device_memory_callbacks.html" > VmaDeviceMemoryCallbacks< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga5e2eb68d727cfd4df25702b027b7aa31" > VmaDeviceMemoryCallbacks< / a > < / td > < / tr >
< tr class = "memdesc:ga5e2eb68d727cfd4df25702b027b7aa31" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory. < a href = "#ga5e2eb68d727cfd4df25702b027b7aa31" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga5e2eb68d727cfd4df25702b027b7aa31" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gac51ae2c316ee760ec5aebbae06d31253" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > VmaAllocatorFlagBits< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gac51ae2c316ee760ec5aebbae06d31253" > VmaAllocatorFlagBits< / a > < / td > < / tr >
< tr class = "memdesc:gac51ae2c316ee760ec5aebbae06d31253" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Flags for created VmaAllocator. < a href = "#gac51ae2c316ee760ec5aebbae06d31253" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gac51ae2c316ee760ec5aebbae06d31253" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga6ffbcb80208bf4467a1104087396cf59" > < td class = "memItemLeft" align = "right" valign = "top" > typedef VkFlags  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga6ffbcb80208bf4467a1104087396cf59" > VmaAllocatorFlags< / a > < / td > < / tr >
< tr class = "separator:ga6ffbcb80208bf4467a1104087396cf59" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-22 14:57:38 +00:00
< tr class = "memitem:ga97064a1a271b0061ebfc3a079862d0c5" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_vma_vulkan_functions.html" > VmaVulkanFunctions< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga97064a1a271b0061ebfc3a079862d0c5" > VmaVulkanFunctions< / a > < / td > < / tr >
< tr class = "separator:ga97064a1a271b0061ebfc3a079862d0c5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-20 09:17:23 +00:00
< tr class = "memitem:gae0f6d1d733dded220d28134da46b4283" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gae0f6d1d733dded220d28134da46b4283" > VmaAllocatorCreateInfo< / a > < / td > < / tr >
< tr class = "memdesc:gae0f6d1d733dded220d28134da46b4283" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Description of a Allocator to be created. < a href = "#gae0f6d1d733dded220d28134da46b4283" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gae0f6d1d733dded220d28134da46b4283" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga810b009a788ee8aac72a25b42ffbe31c" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_vma_stat_info.html" > VmaStatInfo< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga810b009a788ee8aac72a25b42ffbe31c" > VmaStatInfo< / a > < / td > < / tr >
< tr class = "separator:ga810b009a788ee8aac72a25b42ffbe31c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-22 14:57:38 +00:00
< tr class = "memitem:ga732be855fb4a7c248e6853d928a729af" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga732be855fb4a7c248e6853d928a729af" > VmaStats< / a > < / td > < / tr >
< tr class = "memdesc:ga732be855fb4a7c248e6853d928a729af" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > General statistics from current state of Allocator. < a href = "#ga732be855fb4a7c248e6853d928a729af" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga732be855fb4a7c248e6853d928a729af" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-20 09:17:23 +00:00
< / table > < table class = "memberdecls" >
2017-07-11 13:22:12 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
< tr class = "memitem:ga34fff29c218d23a7ff7dff44b77b6b6f" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > VmaAllocatorFlagBits< / a > { < a class = "el" href = "group__general.html#gga34fff29c218d23a7ff7dff44b77b6b6fabe92b706180652ceb320da5bc383aef4" > VMA_ALLOCATOR_EXTERNALLY_SYNCHRONIZED_BIT< / a > = 0x00000001,
< a class = "el" href = "group__general.html#gga34fff29c218d23a7ff7dff44b77b6b6fa914e905a08c2e578f76b9d6c418626cc" > VMA_ALLOCATOR_FLAG_BITS_MAX_ENUM< / a > = 0x7FFFFFFF
}< tr class = "memdesc:ga34fff29c218d23a7ff7dff44b77b6b6f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Flags for created VmaAllocator. < a href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > More...< / a > < br / > < / td > < / tr >
< / td > < / tr >
< tr class = "separator:ga34fff29c218d23a7ff7dff44b77b6b6f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
2017-06-20 09:17:23 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga200692051ddb34240248234f5f4c17bb" > < td class = "memItemLeft" align = "right" valign = "top" > VkResult  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga200692051ddb34240248234f5f4c17bb" > vmaCreateAllocator< / a > (const < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a > *pCreateInfo, VmaAllocator *pAllocator)< / td > < / tr >
< tr class = "memdesc:ga200692051ddb34240248234f5f4c17bb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Creates Allocator object. < a href = "#ga200692051ddb34240248234f5f4c17bb" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga200692051ddb34240248234f5f4c17bb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaa8d164061c88f22fb1fd3c8f3534bc1d" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gaa8d164061c88f22fb1fd3c8f3534bc1d" > vmaDestroyAllocator< / a > (VmaAllocator allocator)< / td > < / tr >
< tr class = "memdesc:gaa8d164061c88f22fb1fd3c8f3534bc1d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Destroys allocator object. < a href = "#gaa8d164061c88f22fb1fd3c8f3534bc1d" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa8d164061c88f22fb1fd3c8f3534bc1d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaecabf7b6e91ea87d0316fa0a9e014fe0" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gaecabf7b6e91ea87d0316fa0a9e014fe0" > vmaGetPhysicalDeviceProperties< / a > (VmaAllocator allocator, const VkPhysicalDeviceProperties **ppPhysicalDeviceProperties)< / td > < / tr >
< tr class = "separator:gaecabf7b6e91ea87d0316fa0a9e014fe0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gab88db292a17974f911182543fda52d19" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gab88db292a17974f911182543fda52d19" > vmaGetMemoryProperties< / a > (VmaAllocator allocator, const VkPhysicalDeviceMemoryProperties **ppPhysicalDeviceMemoryProperties)< / td > < / tr >
< tr class = "separator:gab88db292a17974f911182543fda52d19" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga8701444752eb5de4464adb5a2b514bca" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga8701444752eb5de4464adb5a2b514bca" > vmaGetMemoryTypeProperties< / a > (VmaAllocator allocator, uint32_t memoryTypeIndex, VkMemoryPropertyFlags *pFlags)< / td > < / tr >
< tr class = "memdesc:ga8701444752eb5de4464adb5a2b514bca" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Given Memory Type Index, returns Property Flags of this memory type. < a href = "#ga8701444752eb5de4464adb5a2b514bca" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8701444752eb5de4464adb5a2b514bca" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-09-12 18:45:14 +00:00
< tr class = "memitem:gade56bf8dc9f5a5eaddf5f119ed525236" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gade56bf8dc9f5a5eaddf5f119ed525236" > vmaSetCurrentFrameIndex< / a > (VmaAllocator allocator, uint32_t frameIndex)< / td > < / tr >
< tr class = "memdesc:gade56bf8dc9f5a5eaddf5f119ed525236" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sets index of the current frame. < a href = "#gade56bf8dc9f5a5eaddf5f119ed525236" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gade56bf8dc9f5a5eaddf5f119ed525236" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-06-20 09:17:23 +00:00
< tr class = "memitem:ga333b61c1788cb23559177531e6a93ca3" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga333b61c1788cb23559177531e6a93ca3" > vmaCalculateStats< / a > (VmaAllocator allocator, < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a > *pStats)< / td > < / tr >
< tr class = "memdesc:ga333b61c1788cb23559177531e6a93ca3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Retrieves statistics from current state of the Allocator. < a href = "#ga333b61c1788cb23559177531e6a93ca3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga333b61c1788cb23559177531e6a93ca3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaa4fee7eb5253377599ef4fd38c93c2a0" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#gaa4fee7eb5253377599ef4fd38c93c2a0" > vmaBuildStatsString< / a > (VmaAllocator allocator, char **ppStatsString, VkBool32 detailedMap)< / td > < / tr >
< tr class = "memdesc:gaa4fee7eb5253377599ef4fd38c93c2a0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Builds and returns statistics as string in JSON format. < a href = "#gaa4fee7eb5253377599ef4fd38c93c2a0" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa4fee7eb5253377599ef4fd38c93c2a0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga3104eb30d8122c84dd8541063f145288" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__general.html#ga3104eb30d8122c84dd8541063f145288" > vmaFreeStatsString< / a > (VmaAllocator allocator, char *pStatsString)< / td > < / tr >
< tr class = "separator:ga3104eb30d8122c84dd8541063f145288" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
< a id = "gae25f0d55fd91cb166f002b63244800e1" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gae25f0d55fd91cb166f002b63244800e1" > ◆ < / a > < / span > VMA_STATS_STRING_ENABLED< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > #define VMA_STATS_STRING_ENABLED      1< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
2017-07-11 13:22:12 +00:00
< a id = "gab6a6477cda1ce775b30bde96d766203b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gab6a6477cda1ce775b30bde96d766203b" > ◆ < / a > < / span > PFN_vmaAllocateDeviceMemoryFunction< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef void(VKAPI_PTR * PFN_vmaAllocateDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function called after successful vkAllocateMemory. < / p >
< / div >
< / div >
< a id = "gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaef2545dc2e9dd4f29ab9ba6ac6fe2f49" > ◆ < / a > < / span > PFN_vmaFreeDeviceMemoryFunction< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef void(VKAPI_PTR * PFN_vmaFreeDeviceMemoryFunction) (VmaAllocator allocator, uint32_t memoryType, VkDeviceMemory memory, VkDeviceSize size)< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Callback function called before vkFreeMemory. < / p >
< / div >
< / div >
2017-06-20 09:17:23 +00:00
< a id = "gae0f6d1d733dded220d28134da46b4283" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gae0f6d1d733dded220d28134da46b4283" > ◆ < / a > < / span > VmaAllocatorCreateInfo< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a > < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Description of a Allocator to be created. < / p >
2017-07-11 13:22:12 +00:00
< / div >
< / div >
< a id = "gac51ae2c316ee760ec5aebbae06d31253" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gac51ae2c316ee760ec5aebbae06d31253" > ◆ < / a > < / span > VmaAllocatorFlagBits< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > VmaAllocatorFlagBits< / a > < a class = "el" href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > VmaAllocatorFlagBits< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Flags for created VmaAllocator. < / p >
< / div >
< / div >
< a id = "ga6ffbcb80208bf4467a1104087396cf59" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga6ffbcb80208bf4467a1104087396cf59" > ◆ < / a > < / span > VmaAllocatorFlags< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef VkFlags < a class = "el" href = "group__general.html#ga6ffbcb80208bf4467a1104087396cf59" > VmaAllocatorFlags< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "ga5e2eb68d727cfd4df25702b027b7aa31" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga5e2eb68d727cfd4df25702b027b7aa31" > ◆ < / a > < / span > VmaDeviceMemoryCallbacks< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_vma_device_memory_callbacks.html" > VmaDeviceMemoryCallbacks< / a > < a class = "el" href = "struct_vma_device_memory_callbacks.html" > VmaDeviceMemoryCallbacks< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Set of callbacks that the library will call for vkAllocateMemory and vkFreeMemory. < / p >
< p > Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan. < / p >
2017-06-20 09:17:23 +00:00
< / div >
< / div >
< a id = "ga810b009a788ee8aac72a25b42ffbe31c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga810b009a788ee8aac72a25b42ffbe31c" > ◆ < / a > < / span > VmaStatInfo< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_vma_stat_info.html" > VmaStatInfo< / a > < a class = "el" href = "struct_vma_stat_info.html" > VmaStatInfo< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2017-09-22 14:57:38 +00:00
< / div >
< / div >
< a id = "ga732be855fb4a7c248e6853d928a729af" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga732be855fb4a7c248e6853d928a729af" > ◆ < / a > < / span > VmaStats< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a > < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > General statistics from current state of Allocator. < / p >
< / div >
< / div >
< a id = "ga97064a1a271b0061ebfc3a079862d0c5" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga97064a1a271b0061ebfc3a079862d0c5" > ◆ < / a > < / span > VmaVulkanFunctions< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "struct_vma_vulkan_functions.html" > VmaVulkanFunctions< / a > < a class = "el" href = "struct_vma_vulkan_functions.html" > VmaVulkanFunctions< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2017-06-20 09:17:23 +00:00
2017-07-11 13:22:12 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
< a id = "ga34fff29c218d23a7ff7dff44b77b6b6f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga34fff29c218d23a7ff7dff44b77b6b6f" > ◆ < / a > < / span > VmaAllocatorFlagBits< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "group__general.html#ga34fff29c218d23a7ff7dff44b77b6b6f" > VmaAllocatorFlagBits< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Flags for created VmaAllocator. < / p >
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < a id = "gga34fff29c218d23a7ff7dff44b77b6b6fabe92b706180652ceb320da5bc383aef4" > < / a > VMA_ALLOCATOR_EXTERNALLY_SYNCHRONIZED_BIT  < / td > < td class = "fielddoc" > < p > Allocator and all objects created from it will not be synchronized internally, so you must guarantee they are used from only one thread at a time or synchronized externally by you. < / p >
< p > Using this flag may increase performance because internal mutexes are not used. < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < a id = "gga34fff29c218d23a7ff7dff44b77b6b6fa914e905a08c2e578f76b9d6c418626cc" > < / a > VMA_ALLOCATOR_FLAG_BITS_MAX_ENUM  < / td > < td class = "fielddoc" > < / td > < / tr >
< / table >
2017-06-20 09:17:23 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "gaa4fee7eb5253377599ef4fd38c93c2a0" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa4fee7eb5253377599ef4fd38c93c2a0" > ◆ < / a > < / span > vmaBuildStatsString()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaBuildStatsString < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > char **  < / td >
< td class = "paramname" > < em > ppStatsString< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > VkBool32  < / td >
< td class = "paramname" > < em > detailedMap< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Builds and returns statistics as string in JSON format. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [out]< / td > < td class = "paramname" > ppStatsString< / td > < td > Must be freed using < a class = "el" href = "group__general.html#ga3104eb30d8122c84dd8541063f145288" > vmaFreeStatsString()< / a > function. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "ga333b61c1788cb23559177531e6a93ca3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga333b61c1788cb23559177531e6a93ca3" > ◆ < / a > < / span > vmaCalculateStats()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaCalculateStats < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "struct_vma_stats.html" > VmaStats< / a > *  < / td >
< td class = "paramname" > < em > pStats< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Retrieves statistics from current state of the Allocator. < / p >
< / div >
< / div >
< a id = "ga200692051ddb34240248234f5f4c17bb" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga200692051ddb34240248234f5f4c17bb" > ◆ < / a > < / span > vmaCreateAllocator()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > VkResult vmaCreateAllocator < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "struct_vma_allocator_create_info.html" > VmaAllocatorCreateInfo< / a > *  < / td >
< td class = "paramname" > < em > pCreateInfo< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > VmaAllocator *  < / td >
< td class = "paramname" > < em > pAllocator< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Creates Allocator object. < / p >
< / div >
< / div >
< a id = "gaa8d164061c88f22fb1fd3c8f3534bc1d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa8d164061c88f22fb1fd3c8f3534bc1d" > ◆ < / a > < / span > vmaDestroyAllocator()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaDestroyAllocator < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Destroys allocator object. < / p >
< / div >
< / div >
< a id = "ga3104eb30d8122c84dd8541063f145288" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga3104eb30d8122c84dd8541063f145288" > ◆ < / a > < / span > vmaFreeStatsString()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaFreeStatsString < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > char *  < / td >
< td class = "paramname" > < em > pStatsString< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a id = "gab88db292a17974f911182543fda52d19" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gab88db292a17974f911182543fda52d19" > ◆ < / a > < / span > vmaGetMemoryProperties()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaGetMemoryProperties < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const VkPhysicalDeviceMemoryProperties **  < / td >
< td class = "paramname" > < em > ppPhysicalDeviceMemoryProperties< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > PhysicalDeviceMemoryProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own. < / p >
< / div >
< / div >
< a id = "ga8701444752eb5de4464adb5a2b514bca" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga8701444752eb5de4464adb5a2b514bca" > ◆ < / a > < / span > vmaGetMemoryTypeProperties()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaGetMemoryTypeProperties < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > memoryTypeIndex< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > VkMemoryPropertyFlags *  < / td >
< td class = "paramname" > < em > pFlags< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Given Memory Type Index, returns Property Flags of this memory type. < / p >
< p > This is just a convenience function. Same information can be obtained using < a class = "el" href = "group__general.html#gab88db292a17974f911182543fda52d19" > vmaGetMemoryProperties()< / a > . < / p >
< / div >
< / div >
< a id = "gaecabf7b6e91ea87d0316fa0a9e014fe0" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaecabf7b6e91ea87d0316fa0a9e014fe0" > ◆ < / a > < / span > vmaGetPhysicalDeviceProperties()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaGetPhysicalDeviceProperties < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const VkPhysicalDeviceProperties **  < / td >
< td class = "paramname" > < em > ppPhysicalDeviceProperties< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > PhysicalDeviceProperties are fetched from physicalDevice by the allocator. You can access it here, without fetching it again on your own. < / p >
2017-09-12 18:45:14 +00:00
< / div >
< / div >
< a id = "gade56bf8dc9f5a5eaddf5f119ed525236" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gade56bf8dc9f5a5eaddf5f119ed525236" > ◆ < / a > < / span > vmaSetCurrentFrameIndex()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void vmaSetCurrentFrameIndex < / td >
< td > (< / td >
< td class = "paramtype" > VmaAllocator  < / td >
< td class = "paramname" > < em > allocator< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > frameIndex< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sets index of the current frame. < / p >
< p > This function must be used if you make allocations with < code > VMA_ALLOCATION_CREATE_CAN_BECOME_LOST_BIT< / code > and < code > VMA_ALLOCATION_CREATE_CAN_MAKE_OTHER_LOST_BIT< / code > flags to inform the allocator when a new frame begins. Allocations queried using < a class = "el" href = "group__layer2.html#ga86dd08aba8633bfa4ad0df2e76481d8b" title = "Returns current information about specified allocation. " > vmaGetAllocationInfo()< / a > cannot become lost in the current frame. < / p >
2017-06-20 09:17:23 +00:00
< / div >
< / div >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.13
< / small > < / address >
< / body >
< / html >
