|
5 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
6 | 6 | <meta name="generator" content="Doxygen 1.13.0"/> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
8 | | -<title>Direct3D 12 Memory Allocator: D3D12MA::Allocator Class Reference</title> |
| 8 | +<title>D3D12 Memory Allocator: D3D12MA::Allocator Class Reference</title> |
9 | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
10 | 10 | <script type="text/javascript" src="jquery.js"></script> |
11 | 11 | <script type="text/javascript" src="dynsections.js"></script> |
|
25 | 25 | <tbody> |
26 | 26 | <tr id="projectrow"> |
27 | 27 | <td id="projectalign"> |
28 | | - <div id="projectname">Direct3D 12 Memory Allocator |
| 28 | + <div id="projectname">D3D12 Memory Allocator |
29 | 29 | </div> |
30 | 30 | </td> |
31 | 31 | </tr> |
|
120 | 120 | <tr class="memitem:a3f3fd1e88cf2cd02257fe272e08a273c" id="r_a3f3fd1e88cf2cd02257fe272e08a273c"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f3fd1e88cf2cd02257fe272e08a273c">IsGPUUploadHeapSupported</a> () const</td></tr> |
121 | 121 | <tr class="memdesc:a3f3fd1e88cf2cd02257fe272e08a273c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if GPU Upload Heaps are supported on the current system. <br /></td></tr> |
122 | 122 | <tr class="separator:a3f3fd1e88cf2cd02257fe272e08a273c"><td class="memSeparator" colspan="2"> </td></tr> |
| 123 | +<tr class="memitem:a3f5aa191cebdca7c1932da4723cfc03e" id="r_a3f5aa191cebdca7c1932da4723cfc03e"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f5aa191cebdca7c1932da4723cfc03e">IsTightAlignmentSupported</a> () const</td></tr> |
| 124 | +<tr class="memdesc:a3f5aa191cebdca7c1932da4723cfc03e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless <a class="el" href="namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916af13bc700d7b799c856c6516acac12fed">ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT</a> flag was specified on allocator creation. <br /></td></tr> |
| 125 | +<tr class="separator:a3f5aa191cebdca7c1932da4723cfc03e"><td class="memSeparator" colspan="2"> </td></tr> |
123 | 126 | <tr class="memitem:a434ae3147209953253da26687bfd62dc" id="r_a434ae3147209953253da26687bfd62dc"><td class="memItemLeft" align="right" valign="top">UINT64 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a434ae3147209953253da26687bfd62dc">GetMemoryCapacity</a> (UINT memorySegmentGroup) const</td></tr> |
124 | 127 | <tr class="memdesc:a434ae3147209953253da26687bfd62dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns total amount of memory of specific segment group, in bytes. <br /></td></tr> |
125 | 128 | <tr class="separator:a434ae3147209953253da26687bfd62dc"><td class="memSeparator" colspan="2"> </td></tr> |
@@ -753,7 +756,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a434ae3147209953253da2668 |
753 | 756 | <p>Returns total amount of memory of specific segment group, in bytes. </p> |
754 | 757 | <dl class="params"><dt>Parameters</dt><dd> |
755 | 758 | <table class="params"> |
756 | | - <tr><td class="paramname">memorySegmentGroup</td><td>use <code>DXGI_MEMORY_SEGMENT_GROUP_LOCAL</code> or DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL`.</td></tr> |
| 759 | + <tr><td class="paramname">memorySegmentGroup</td><td>use <code>DXGI_MEMORY_SEGMENT_GROUP_LOCAL</code> or <code>DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL</code>.</td></tr> |
757 | 760 | </table> |
758 | 761 | </dd> |
759 | 762 | </dl> |
@@ -815,8 +818,27 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3f3fd1e88cf2cd02257fe272 |
815 | 818 |
|
816 | 819 | <p>Returns true if GPU Upload Heaps are supported on the current system. </p> |
817 | 820 | <p>When true, you can use <code>D3D12_HEAP_TYPE_GPU_UPLOAD</code>.</p> |
818 | | -<p>This flag is fetched from <code>D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported</code>.</p> |
819 | | -<p><code>#define D3D12MA_OPTIONS16_SUPPORTED 1</code> is needed for the compilation of this library. Otherwise the flag is always false. </p> |
| 821 | +<p>This flag is fetched from <code>D3D12_FEATURE_D3D12_OPTIONS16::GPUUploadHeapSupported</code>. </p> |
| 822 | + |
| 823 | +</div> |
| 824 | +</div> |
| 825 | +<a id="a3f5aa191cebdca7c1932da4723cfc03e" name="a3f5aa191cebdca7c1932da4723cfc03e"></a> |
| 826 | +<h2 class="memtitle"><span class="permalink"><a href="#a3f5aa191cebdca7c1932da4723cfc03e">◆ </a></span>IsTightAlignmentSupported()</h2> |
| 827 | + |
| 828 | +<div class="memitem"> |
| 829 | +<div class="memproto"> |
| 830 | + <table class="memname"> |
| 831 | + <tr> |
| 832 | + <td class="memname">BOOL D3D12MA::Allocator::IsTightAlignmentSupported </td> |
| 833 | + <td>(</td> |
| 834 | + <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| 835 | + <td> const</td> |
| 836 | + </tr> |
| 837 | + </table> |
| 838 | +</div><div class="memdoc"> |
| 839 | + |
| 840 | +<p>Returns true if resource tight alignment is supported on the current system. When supported, it is automatically used by the library, unless <a class="el" href="namespace_d3_d12_m_a.html#ad5ae5a5e42b878f2e18ab5d1fbfb9916af13bc700d7b799c856c6516acac12fed">ALLOCATOR_FLAG_DONT_USE_TIGHT_ALIGNMENT</a> flag was specified on allocator creation. </p> |
| 841 | +<p>This flag is fetched from <code>D3D12_FEATURE_DATA_TIGHT_ALIGNMENT::SupportTier</code>. </p> |
820 | 842 |
|
821 | 843 | </div> |
822 | 844 | </div> |
|
0 commit comments