AuroraMiddleware/VulkanMemoryAllocator
1
0
Fork 0
mirror of https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator synced 2024-11-05 12:20:07 +00:00
Code Issues Projects Releases Wiki Activity

Minor update in documentation.

Browse Source
This commit is contained in:
Adam Sawicki 2018-02-22 18:23:29 +01:00
parent d566e37e22
commit c793ba342f
6 changed files with 211 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
docs/html/about_the_library.html Normal file
View File

@ -0,0 +1,84 @@
<!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: About the library</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">About the library </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="about_the_library_features_not_supported"></a>
Features not supported</h1>
<p>Features deliberately excluded from the scope of this library:</p>
<ul>
<li>Data transfer - issuing commands that transfer data between buffers or images, any usage of <code>VkCommandList</code> or <code>VkCommandQueue</code> and related synchronization is responsibility of the user.</li>
<li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li>
</ul>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

3
docs/html/index.html
View File

@ -63,7 +63,7 @@ $(function() {
</div><!--header--> </div><!--header-->
<div class="contents"> <div class="contents">
<div class="textblock"><p><b>Version 2.0.0-alpha.7</b> (2018-02-09)</p> <div class="textblock"><p><b>Version 2.0.0-alpha.7</b> (2018-02-09)</p>
<p>Copyright (c) 2017 Advanced Micro Devices, Inc. All rights reserved. <br /> <p>Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved. <br />
License: MIT</p> License: MIT</p>
<p>Documentation of all members: <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></p> <p>Documentation of all members: <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></p>
<p>Table of contents:</p> <p>Table of contents:</p>
@ -83,6 +83,7 @@ License: MIT</p>
</ul> </ul>
</li> </li>
<li><a class="el" href="thread_safety.html">Thread safety</a></li> <li><a class="el" href="thread_safety.html">Thread safety</a></li>
<li><a class="el" href="about_the_library.html">About the library</a></li>
</ul> </ul>
<p>See also:</p> <p>See also:</p>
<ul> <ul>

1
docs/html/search/all_0.js
View File

@ -1,5 +1,6 @@
var searchData= var searchData=
[ [
['about_20the_20library',['About the library',['../about_the_library.html',1,'index']]],
['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]], ['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]],
['allocationcount',['allocationCount',['../struct_vma_stat_info.html#a537741e4d5cdddc1c0ab95ec650afaff',1,'VmaStatInfo::allocationCount()'],['../struct_vma_pool_stats.html#ad1924eb54fffa45e9e0e65670c8fe5eb',1,'VmaPoolStats::allocationCount()']]], ['allocationcount',['allocationCount',['../struct_vma_stat_info.html#a537741e4d5cdddc1c0ab95ec650afaff',1,'VmaStatInfo::allocationCount()'],['../struct_vma_pool_stats.html#ad1924eb54fffa45e9e0e65670c8fe5eb',1,'VmaPoolStats::allocationCount()']]],
['allocationsizeavg',['allocationSizeAvg',['../struct_vma_stat_info.html#a1081a039964e566c672e7a2347f9e599',1,'VmaStatInfo']]], ['allocationsizeavg',['allocationSizeAvg',['../struct_vma_stat_info.html#a1081a039964e566c672e7a2347f9e599',1,'VmaStatInfo']]],

1
docs/html/search/pages_0.js
View File

@ -1,4 +1,5 @@
var searchData= var searchData=
[ [
['about_20the_20library',['About the library',['../about_the_library.html',1,'index']]],
['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]] ['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
]; ];

218
docs/html/vk__mem__alloc_8h_source.html
View File

File diff suppressed because one or more lines are too long

15
src/vk_mem_alloc.h
View File

@ -31,7 +31,7 @@ extern "C" {
<b>Version 2.0.0-alpha.7</b> (2018-02-09) <b>Version 2.0.0-alpha.7</b> (2018-02-09)
Copyright (c) 2017 Advanced Micro Devices, Inc. All rights reserved. \n Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved. \n
License: MIT License: MIT
Documentation of all members: vk_mem_alloc.h Documentation of all members: vk_mem_alloc.h
@ -49,6 +49,7 @@ Table of contents:
- \subpage configuration - \subpage configuration
- \subpage vk_khr_dedicated_allocation - \subpage vk_khr_dedicated_allocation
- \subpage thread_safety - \subpage thread_safety
- \subpage about_the_library
See also: See also:
@ -718,6 +719,18 @@ To learn more about this extension, see:
threads at the same time if you pass the same `VmaAllocation` object to these threads at the same time if you pass the same `VmaAllocation` object to these
functions. functions.
\page about_the_library About the library
\section about_the_library_features_not_supported Features not supported
Features deliberately excluded from the scope of this library:
- Data transfer - issuing commands that transfer data between buffers or images, any usage of
`VkCommandList` or `VkCommandQueue` and related synchronization is responsibility of the user.
- Support for any programming languages other than C/C++.
Bindings to other languages are welcomed as external projects.
*/ */
#include <vulkan/vulkan.h> #include <vulkan/vulkan.h>