Add ktx
This commit is contained in:
@@ -0,0 +1,344 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.16.1"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>libktx Reference: ktxVulkanTexture Class Reference</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>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript" src="cookie.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 id="projectrow">
|
||||
<td id="projectlogo"><img alt="Logo" src="ktx_logo_200.png"/></td>
|
||||
<td id="projectalign">
|
||||
<div id="projectname">libktx Reference<span id="projectnumber"> 0.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Libraries and tools to create and read KTX image texture files.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.16.1 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
$(function() { codefold.init(); });
|
||||
</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',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
$(function(){initNavTree('structktxVulkanTexture.html','',''); });
|
||||
</script>
|
||||
<div id="container">
|
||||
<div id="doc-content">
|
||||
<!-- 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">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle"><div class="title">ktxVulkanTexture Class Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions.
|
||||
<a href="#details">More...</a></p>
|
||||
|
||||
<p><code>#include <ktxvulkan.h></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ga5a783db9431738b9b18b9fc585183490" id="r_ga5a783db9431738b9b18b9fc585183490"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#ga5a783db9431738b9b18b9fc585183490">ktxVulkanTexture_Destruct_WithSuballocator</a> (<a class="el" href="structktxVulkanTexture.html">ktxVulkanTexture</a> *vkTexture, VkDevice device, const VkAllocationCallbacks *pAllocator, <a class="el" href="structktxVulkanTexture__subAllocatorCallbacks.html">ktxVulkanTexture_subAllocatorCallbacks</a> *subAllocatorCallbacks)</td></tr>
|
||||
<tr class="memdesc:ga5a783db9431738b9b18b9fc585183490"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the object returned when loading a texture image. <br /></td></tr>
|
||||
<tr class="memitem:gaf620a84f6bc59bff03b521e55a654f19" id="r_gaf620a84f6bc59bff03b521e55a654f19"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#gaf620a84f6bc59bff03b521e55a654f19">ktxVulkanTexture_Destruct</a> (<a class="el" href="structktxVulkanTexture.html">ktxVulkanTexture</a> *vkTexture, VkDevice device, const VkAllocationCallbacks *pAllocator)</td></tr>
|
||||
<tr class="memdesc:gaf620a84f6bc59bff03b521e55a654f19"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the object returned when loading a texture image. <br /></td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
||||
Data Fields</h2></td></tr>
|
||||
<tr class="memitem:ab0a61f410df5e84b033e0628354286b1" id="r_ab0a61f410df5e84b033e0628354286b1"><td class="memItemLeft">PFN_vkDestroyImage </td><td class="memItemRight"><a class="el" href="#ab0a61f410df5e84b033e0628354286b1">vkDestroyImage</a></td></tr>
|
||||
<tr class="memitem:a190ebc88642185342b8503667919d276" id="r_a190ebc88642185342b8503667919d276"><td class="memItemLeft">PFN_vkFreeMemory </td><td class="memItemRight"><a class="el" href="#a190ebc88642185342b8503667919d276">vkFreeMemory</a></td></tr>
|
||||
<tr class="memitem:ac48af4a2f518b64b67c40aa0efa7de6b" id="r_ac48af4a2f518b64b67c40aa0efa7de6b"><td class="memItemLeft">VkImage </td><td class="memItemRight"><a class="el" href="#ac48af4a2f518b64b67c40aa0efa7de6b">image</a></td></tr>
|
||||
<tr class="memitem:ad2bc860aeb9a158aa37eb3e09db3638e" id="r_ad2bc860aeb9a158aa37eb3e09db3638e"><td class="memItemLeft">VkFormat </td><td class="memItemRight"><a class="el" href="#ad2bc860aeb9a158aa37eb3e09db3638e">imageFormat</a></td></tr>
|
||||
<tr class="memitem:ad69bab0528dbcee4c8780b488670a179" id="r_ad69bab0528dbcee4c8780b488670a179"><td class="memItemLeft">VkImageLayout </td><td class="memItemRight"><a class="el" href="#ad69bab0528dbcee4c8780b488670a179">imageLayout</a></td></tr>
|
||||
<tr class="memitem:a68699cf926eef628d726fe0fa402c34d" id="r_a68699cf926eef628d726fe0fa402c34d"><td class="memItemLeft">VkDeviceMemory </td><td class="memItemRight"><a class="el" href="#a68699cf926eef628d726fe0fa402c34d">deviceMemory</a></td></tr>
|
||||
<tr class="memitem:a3da1a8fe11560f0b2fa98a07e12a1fb7" id="r_a3da1a8fe11560f0b2fa98a07e12a1fb7"><td class="memItemLeft">VkImageViewType </td><td class="memItemRight"><a class="el" href="#a3da1a8fe11560f0b2fa98a07e12a1fb7">viewType</a></td></tr>
|
||||
<tr class="memitem:a325272ddd9a962f05deb905101d25cbd" id="r_a325272ddd9a962f05deb905101d25cbd"><td class="memItemLeft">uint32_t </td><td class="memItemRight"><a class="el" href="#a325272ddd9a962f05deb905101d25cbd">width</a></td></tr>
|
||||
<tr class="memitem:a6ad4f820ce4e75cda0686fcaad5168be" id="r_a6ad4f820ce4e75cda0686fcaad5168be"><td class="memItemLeft">uint32_t </td><td class="memItemRight"><a class="el" href="#a6ad4f820ce4e75cda0686fcaad5168be">height</a></td></tr>
|
||||
<tr class="memitem:af43b771026fceb9a0b28256afc08f69b" id="r_af43b771026fceb9a0b28256afc08f69b"><td class="memItemLeft">uint32_t </td><td class="memItemRight"><a class="el" href="#af43b771026fceb9a0b28256afc08f69b">depth</a></td></tr>
|
||||
<tr class="memitem:afaaf1db5d13d0299791944833b03af9c" id="r_afaaf1db5d13d0299791944833b03af9c"><td class="memItemLeft">uint32_t </td><td class="memItemRight"><a class="el" href="#afaaf1db5d13d0299791944833b03af9c">levelCount</a></td></tr>
|
||||
<tr class="memitem:a387ad43ce8155b27c8feab827f437a40" id="r_a387ad43ce8155b27c8feab827f437a40"><td class="memItemLeft">uint32_t </td><td class="memItemRight"><a class="el" href="#a387ad43ce8155b27c8feab827f437a40">layerCount</a></td></tr>
|
||||
<tr class="memitem:a723f84255a60631ba53e0c5d2f8f398f" id="r_a723f84255a60631ba53e0c5d2f8f398f"><td class="memItemLeft">uint64_t </td><td class="memItemRight"><a class="el" href="#a723f84255a60631ba53e0c5d2f8f398f">allocationId</a></td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Struct for returning information about the Vulkan texture image created by the ktxTexture_VkUpload* functions. </p>
|
||||
<p>Creation of these objects is internal to the upload functions. </p>
|
||||
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="vkload_8cpp-example.html#_a0">vkload.cpp</a>.</dd>
|
||||
</dl>
|
||||
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
|
||||
<a id="a723f84255a60631ba53e0c5d2f8f398f" name="a723f84255a60631ba53e0c5d2f8f398f"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a723f84255a60631ba53e0c5d2f8f398f">◆ </a></span>allocationId</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint64_t allocationId</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>An id referencing suballocation(s). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="af43b771026fceb9a0b28256afc08f69b" name="af43b771026fceb9a0b28256afc08f69b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af43b771026fceb9a0b28256afc08f69b">◆ </a></span>depth</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t depth</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The depth of the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a68699cf926eef628d726fe0fa402c34d" name="a68699cf926eef628d726fe0fa402c34d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a68699cf926eef628d726fe0fa402c34d">◆ </a></span>deviceMemory</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">VkDeviceMemory deviceMemory</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The memory (sub)allocation for the image on the Vulkan device. Will not be used with suballocators. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a6ad4f820ce4e75cda0686fcaad5168be" name="a6ad4f820ce4e75cda0686fcaad5168be"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a6ad4f820ce4e75cda0686fcaad5168be">◆ </a></span>height</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t height</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The height of the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac48af4a2f518b64b67c40aa0efa7de6b" name="ac48af4a2f518b64b67c40aa0efa7de6b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac48af4a2f518b64b67c40aa0efa7de6b">◆ </a></span>image</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">VkImage image</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Handle to the Vulkan image created by the loader. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad2bc860aeb9a158aa37eb3e09db3638e" name="ad2bc860aeb9a158aa37eb3e09db3638e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad2bc860aeb9a158aa37eb3e09db3638e">◆ </a></span>imageFormat</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">VkFormat imageFormat</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Format of the image data. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad69bab0528dbcee4c8780b488670a179" name="ad69bab0528dbcee4c8780b488670a179"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad69bab0528dbcee4c8780b488670a179">◆ </a></span>imageLayout</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">VkImageLayout imageLayout</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Layout of the created image. Has the same value as <code class="param">layout</code> parameter passed to the loader. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a387ad43ce8155b27c8feab827f437a40" name="a387ad43ce8155b27c8feab827f437a40"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a387ad43ce8155b27c8feab827f437a40">◆ </a></span>layerCount</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t layerCount</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The number of array layers in the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="afaaf1db5d13d0299791944833b03af9c" name="afaaf1db5d13d0299791944833b03af9c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#afaaf1db5d13d0299791944833b03af9c">◆ </a></span>levelCount</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t levelCount</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The number of MIP levels in the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a3da1a8fe11560f0b2fa98a07e12a1fb7" name="a3da1a8fe11560f0b2fa98a07e12a1fb7"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3da1a8fe11560f0b2fa98a07e12a1fb7">◆ </a></span>viewType</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">VkImageViewType viewType</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>ViewType corresponding to <code class="param">image</code>. Reflects the dimensionality, cubeness and arrayness of the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab0a61f410df5e84b033e0628354286b1" name="ab0a61f410df5e84b033e0628354286b1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab0a61f410df5e84b033e0628354286b1">◆ </a></span>vkDestroyImage</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">PFN_vkDestroyImage vkDestroyImage</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Pointer to vkDestroyImage function </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a190ebc88642185342b8503667919d276" name="a190ebc88642185342b8503667919d276"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a190ebc88642185342b8503667919d276">◆ </a></span>vkFreeMemory</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">PFN_vkFreeMemory vkFreeMemory</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Pointer to vkFreeMemory function </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a325272ddd9a962f05deb905101d25cbd" name="a325272ddd9a962f05deb905101d25cbd"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a325272ddd9a962f05deb905101d25cbd">◆ </a></span>width</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">uint32_t width</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>The width of the image. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div id="page-nav" class="page-nav-panel">
|
||||
<div id="page-nav-resize-handle"></div>
|
||||
<div id="page-nav-tree">
|
||||
<div id="page-nav-contents">
|
||||
</div><!-- page-nav-contents -->
|
||||
</div><!-- page-nav-tree -->
|
||||
</div><!-- page-nav -->
|
||||
</div><!-- container -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="structktxVulkanTexture.html">ktxVulkanTexture</a></li>
|
||||
<li class="footer">Generated on <span class="timestamp"></span> for libktx Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user