Skip to content

Commit c793ba3

Browse files
adam-sawicki-aadam-sawicki-a
committed
Minor update in documentation.
1 parent d566e37 commit c793ba3

File tree

6 files changed

+211
-111
lines changed

6 files changed

+211
-111
lines changed

‎docs/html/about_the_library.html

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Vulkan Memory Allocator: About the library</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">Vulkan Memory Allocator
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
<!-- window showing the filter options -->
46+
<div id="MSearchSelectWindow"
47+
onmouseover="return searchBox.OnSearchSelectShow()"
48+
onmouseout="return searchBox.OnSearchSelectHide()"
49+
onkeydown="return searchBox.OnSearchSelectKey(event)">
50+
</div>
51+
52+
<!-- iframe showing the search results (closed by default) -->
53+
<div id="MSearchResultsWindow">
54+
<iframe src="javascript:void(0)" frameborder="0"
55+
name="MSearchResults" id="MSearchResults">
56+
</iframe>
57+
</div>
58+
59+
<div id="nav-path" class="navpath">
60+
<ul>
61+
<li class="navelem"><a class="el" href="index.html">Vulkan Memory Allocator</a></li> </ul>
62+
</div>
63+
</div><!-- top -->
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">About the library </div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
<div class="textblock"><h1><a class="anchor" id="about_the_library_features_not_supported"></a>
70+
Features not supported</h1>
71+
<p>Features deliberately excluded from the scope of this library:</p>
72+
<ul>
73+
<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>
74+
<li>Support for any programming languages other than C/C++. Bindings to other languages are welcomed as external projects. </li>
75+
</ul>
76+
</div></div><!-- contents -->
77+
<!-- start footer part -->
78+
<hr class="footer"/><address class="footer"><small>
79+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
80+
<img class="footer" src="doxygen.png" alt="doxygen"/>
81+
</a> 1.8.13
82+
</small></address>
83+
</body>
84+
</html>

‎docs/html/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
</div><!--header-->
6464
<div class="contents">
6565
<div class="textblock"><p><b>Version 2.0.0-alpha.7</b> (2018-02-09)</p>
66-
<p>Copyright (c) 2017 Advanced Micro Devices, Inc. All rights reserved. <br />
66+
<p>Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved. <br />
6767
License: MIT</p>
6868
<p>Documentation of all members: <a class="el" href="vk__mem__alloc_8h.html">vk_mem_alloc.h</a></p>
6969
<p>Table of contents:</p>
@@ -83,6 +83,7 @@
8383
</ul>
8484
</li>
8585
<li><a class="el" href="thread_safety.html">Thread safety</a></li>
86+
<li><a class="el" href="about_the_library.html">About the library</a></li>
8687
</ul>
8788
<p>See also:</p>
8889
<ul>

‎docs/html/search/all_0.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
var searchData=
22
[
3+
['about_20the_20library',['About the library',['../about_the_library.html',1,'index']]],
34
['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]],
45
['allocationcount',['allocationCount',['../struct_vma_stat_info.html#a537741e4d5cdddc1c0ab95ec650afaff',1,'VmaStatInfo::allocationCount()'],['../struct_vma_pool_stats.html#ad1924eb54fffa45e9e0e65670c8fe5eb',1,'VmaPoolStats::allocationCount()']]],
56
['allocationsizeavg',['allocationSizeAvg',['../struct_vma_stat_info.html#a1081a039964e566c672e7a2347f9e599',1,'VmaStatInfo']]],

‎docs/html/search/pages_0.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
var searchData=
22
[
3+
['about_20the_20library',['About the library',['../about_the_library.html',1,'index']]],
34
['allocation_20names_20and_20user_20data',['Allocation names and user data',['../allocation_annotation.html',1,'index']]]
45
];

‎docs/html/vk__mem__alloc_8h_source.html

Lines changed: 109 additions & 109 deletions
Large diffs are not rendered by default.

‎src/vk_mem_alloc.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ extern "C" {
3131
3232
<b>Version 2.0.0-alpha.7</b> (2018-02-09)
3333
34-
Copyright (c) 2017 Advanced Micro Devices, Inc. All rights reserved. \n
34+
Copyright (c) 2017-2018 Advanced Micro Devices, Inc. All rights reserved. \n
3535
License: MIT
3636
3737
Documentation of all members: vk_mem_alloc.h
@@ -49,6 +49,7 @@ Table of contents:
4949
- \subpage configuration
5050
- \subpage vk_khr_dedicated_allocation
5151
- \subpage thread_safety
52+
- \subpage about_the_library
5253
5354
See also:
5455
@@ -718,6 +719,18 @@ To learn more about this extension, see:
718719
threads at the same time if you pass the same `VmaAllocation` object to these
719720
functions.
720721
722+
723+
\page about_the_library About the library
724+
725+
\section about_the_library_features_not_supported Features not supported
726+
727+
Features deliberately excluded from the scope of this library:
728+
729+
- Data transfer - issuing commands that transfer data between buffers or images, any usage of
730+
`VkCommandList` or `VkCommandQueue` and related synchronization is responsibility of the user.
731+
- Support for any programming languages other than C/C++.
732+
Bindings to other languages are welcomed as external projects.
733+
721734
*/
722735

723736
#include <vulkan/vulkan.h>

0 commit comments

Comments
 (0)