wut/gx2_2debug_8h_source.html

113 lines
32 KiB
HTML
Raw Normal View History

2018-07-26 20:52:03 +10: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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: include/gx2/debug.h Source File</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">wut
&#160;<span id="projectnumber">1.0.0-alpha</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_64fe89c4a61f5742775721f1d8222d0c.html">gx2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">debug.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="gx2_2debug_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="wut_8h.html">wut.h</a>&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="surface_8h.html">surface.h</a>&quot;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#gabfcc08b8614628fae95cf4775cf91752"> 15</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structGX2DebugCaptureInterface.html">GX2DebugCaptureInterface</a> <a class="code" href="structGX2DebugCaptureInterface.html">GX2DebugCaptureInterface</a>;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#ga13750166e96ff226d8183225ea3b4679"> 17</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="group__gx2__debug.html#ga13750166e96ff226d8183225ea3b4679">GX2DebugCaptureInterfaceVersion</a></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#gga13750166e96ff226d8183225ea3b4679a1aceebb070441ffa42f5d1a3ed015504"> 19</a></span>&#160; <a class="code" href="group__gx2__debug.html#gga13750166e96ff226d8183225ea3b4679a1aceebb070441ffa42f5d1a3ed015504">GX2_DEBUG_CAPTURE_INTERFACE_VERSION</a> = 1,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;} <a class="code" href="group__gx2__debug.html#ga13750166e96ff226d8183225ea3b4679">GX2DebugCaptureInterfaceVersion</a>;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#ga2d14451517a0f5ee0657435081bbe01b"> 22</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="group__gx2__debug.html#ga2d14451517a0f5ee0657435081bbe01b">GX2DebugCaptureStartFlags</a></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01ba298a91e9d3d4bc9656b085d6bafe95b9"> 24</a></span>&#160; <a class="code" href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01ba298a91e9d3d4bc9656b085d6bafe95b9">GX2_DEBUG_CAPTURE_START_FLAGS_NONE</a> = 0,</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01babb83924403f19c795ee92ec5eea51efe"> 27</a></span>&#160; <a class="code" href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01babb83924403f19c795ee92ec5eea51efe">GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE</a> = 1,</div><div class="line
<div class="ttc" id="structGX2DebugCaptureInterface_html_ac553cbbb1ead51f0325bd2395a72ff34"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#ac553cbbb1ead51f0325bd2395a72ff34">GX2DebugCaptureInterface::setAllocator</a></div><div class="ttdeci">void(* setAllocator)()</div><div class="ttdoc">Called from GX2DebugSetCaptureInterface with the default gx2 allocators. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00047">debug.h:47</a></div></div>
<div class="ttc" id="group__gx2__debug_html_ga2cb9b55fecfb05eea4a17dbd8ff737c8"><div class="ttname"><a href="group__gx2__debug.html#ga2cb9b55fecfb05eea4a17dbd8ff737c8">_GX2DebugSetCaptureInterface</a></div><div class="ttdeci">BOOL _GX2DebugSetCaptureInterface(GX2DebugCaptureInterface *interface)</div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_aa6e1c45ba923a88daa34e7c47489be57"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#aa6e1c45ba923a88daa34e7c47489be57">GX2DebugCaptureInterface::onUnknownMemory</a></div><div class="ttdeci">void(* onUnknownMemory)(void *ptr, uint32_t size)</div><div class="ttdoc">UNKNOWN: Called when something happens with some memory. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00066">debug.h:66</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_af2b47e53aa2504d49c12ead678e71d48"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#af2b47e53aa2504d49c12ead678e71d48">GX2DebugCaptureInterface::onSwapScanBuffers</a></div><div class="ttdeci">void(* onSwapScanBuffers)(GX2Surface *surface)</div><div class="ttdoc">Called from GX2SwapScanBuffers with the TV scan buffer. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00072">debug.h:72</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_a8e670e5f59c71a4799069540f606a80d"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#a8e670e5f59c71a4799069540f606a80d">GX2DebugCaptureInterface::onAlloc</a></div><div class="ttdeci">void(* onAlloc)(void *ptr, uint32_t size, uint32_t align)</div><div class="ttdoc">Called when GX2 memory is allocated. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00060">debug.h:60</a></div></div>
<div class="ttc" id="group__gx2__debug_html_ggaaaeb82ee28c72bd7d22c0425626e35e4ada316251b32404b3632751ebd4fc57b6"><div class="ttname"><a href="group__gx2__debug.html#ggaaaeb82ee28c72bd7d22c0425626e35e4ada316251b32404b3632751ebd4fc57b6">GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH</a></div><div class="ttdoc">When set GX2DebugCaptureEnd will NOT call GX2Flush. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00035">debug.h:35</a></div></div>
<div class="ttc" id="group__gx2__debug_html_gae0fd17485d316fc71ad25b1deda6d90c"><div class="ttname"><a href="group__gx2__debug.html#gae0fd17485d316fc71ad25b1deda6d90c">GX2DebugCaptureFrame</a></div><div class="ttdeci">void GX2DebugCaptureFrame(const char *filename)</div><div class="ttdoc">Will capture the next frame. </div></div>
<div class="ttc" id="group__gx2__debug_html_ggaaaeb82ee28c72bd7d22c0425626e35e4a13c1d5c232a8b7e88a07d1873c456f66"><div class="ttname"><a href="group__gx2__debug.html#ggaaaeb82ee28c72bd7d22c0425626e35e4a13c1d5c232a8b7e88a07d1873c456f66">GX2_DEBUG_CAPTURE_END_FLAGS_NONE</a></div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00032">debug.h:32</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_afdd52ac850766c51c16e85f0a9a65d27"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#afdd52ac850766c51c16e85f0a9a65d27">GX2DebugCaptureInterface::onShutdown</a></div><div class="ttdeci">void(* onShutdown)()</div><div class="ttdoc">Called from GX2Shutdown. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00044">debug.h:44</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_a7522f6441e19fb80cdb4b21da744fafb"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#a7522f6441e19fb80cdb4b21da744fafb">GX2DebugCaptureInterface::onCaptureStart</a></div><div class="ttdeci">void(* onCaptureStart)(const char *filename)</div><div class="ttdoc">Called from GX2DebugCaptureStart, the filename is first argument passed in to GX2DebugCaptureStart. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00051">debug.h:51</a></div></div>
<div class="ttc" id="group__gx2__debug_html_ga2d14451517a0f5ee0657435081bbe01b"><div class="ttname"><a href="group__gx2__debug.html#ga2d14451517a0f5ee0657435081bbe01b">GX2DebugCaptureStartFlags</a></div><div class="ttdeci">GX2DebugCaptureStartFlags</div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00022">debug.h:22</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_ae1b811e21e2714b747df75c48c7d06ab"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#ae1b811e21e2714b747df75c48c7d06ab">GX2DebugCaptureInterface::submitToRing</a></div><div class="ttdeci">void(* submitToRing)(void *unk1, uint32_t unk2, uint32_t *unk3, uint64_t *outSubmitTimestamp)</div><div class="ttdoc">Called when a command buffer is ready to be submitted to ring buffer. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00077">debug.h:77</a></div></div>
<div class="ttc" id="wut_8h_html"><div class="ttname"><a href="wut_8h.html">wut.h</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_ab4e11ccf77aff665312b7998d06358a8"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#ab4e11ccf77aff665312b7998d06358a8">GX2DebugCaptureInterface::setOutputSurface</a></div><div class="ttdeci">void(* setOutputSurface)(GX2Surface *surface)</div><div class="ttdoc">Called from GX2DebugCaptureStart with the TV scan buffer. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00069">debug.h:69</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_a1619e28c113273e87bf2339bcd1c5b94"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#a1619e28c113273e87bf2339bcd1c5b94">GX2DebugCaptureInterface::onCaptureEnd</a></div><div class="ttdeci">void(* onCaptureEnd)()</div><div class="ttdoc">Called from GX2DebugCaptureEnd. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00054">debug.h:54</a></div></div>
<div class="ttc" id="group__gx2__debug_html_gga13750166e96ff226d8183225ea3b4679a1aceebb070441ffa42f5d1a3ed015504"><div class="ttname"><a href="group__gx2__debug.html#gga13750166e96ff226d8183225ea3b4679a1aceebb070441ffa42f5d1a3ed015504">GX2_DEBUG_CAPTURE_INTERFACE_VERSION</a></div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00019">debug.h:19</a></div></div>
<div class="ttc" id="group__gx2__surface_html_structGX2Surface"><div class="ttname"><a href="group__gx2__surface.html#structGX2Surface">GX2Surface</a></div><div class="ttdef"><b>Definition:</b> <a href="surface_8h_source.html#l00020">surface.h:20</a></div></div>
<div class="ttc" id="surface_8h_html"><div class="ttname"><a href="surface_8h.html">surface.h</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_a0ad1a11f9b97259ab856807f1a5f5c49"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#a0ad1a11f9b97259ab856807f1a5f5c49">GX2DebugCaptureInterface::isCaptureEnabled</a></div><div class="ttdeci">BOOL(* isCaptureEnabled)()</div><div class="ttdoc">Check if capture is enabled. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00057">debug.h:57</a></div></div>
<div class="ttc" id="group__gx2__debug_html_ga191ec5ee3f351be76e04d9496e92ed64"><div class="ttname"><a href="group__gx2__debug.html#ga191ec5ee3f351be76e04d9496e92ed64">GX2DebugCaptureStart</a></div><div class="ttdeci">void GX2DebugCaptureStart(const char *filename, GX2DebugCaptureStartFlags flags)</div><div class="ttdoc">Starts a debug capture. </div></div>
<div class="ttc" id="group__gx2__debug_html_ga64f51604a706365372fbed2dfc619229"><div class="ttname"><a href="group__gx2__debug.html#ga64f51604a706365372fbed2dfc619229">GX2DebugCaptureFrames</a></div><div class="ttdeci">void GX2DebugCaptureFrames(const char *filename, uint32_t count)</div><div class="ttdoc">Will capture count frames. </div></div>
<div class="ttc" id="wut__types_8h_html_a975dbe9e4396bf9e0064ce01827fa372"><div class="ttname"><a href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a></div><div class="ttdeci">int32_t BOOL</div><div class="ttdef"><b>Definition:</b> <a href="wut__types_8h_source.html#l00004">wut_types.h:4</a></div></div>
<div class="ttc" id="group__gx2__debug_html_gga2d14451517a0f5ee0657435081bbe01babb83924403f19c795ee92ec5eea51efe"><div class="ttname"><a href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01babb83924403f19c795ee92ec5eea51efe">GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE</a></div><div class="ttdoc">When set GX2DebugCaptureEnd will NOT call GX2DrawDone. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00027">debug.h:27</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html"><div class="ttname"><a href="structGX2DebugCaptureInterface.html">GX2DebugCaptureInterface</a></div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00038">debug.h:38</a></div></div>
<div class="ttc" id="group__gx2__debug_html_gaaaeb82ee28c72bd7d22c0425626e35e4"><div class="ttname"><a href="group__gx2__debug.html#gaaaeb82ee28c72bd7d22c0425626e35e4">GX2DebugCaptureEndFlags</a></div><div class="ttdeci">GX2DebugCaptureEndFlags</div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00030">debug.h:30</a></div></div>
<div class="ttc" id="group__gx2__debug_html_gga2d14451517a0f5ee0657435081bbe01ba298a91e9d3d4bc9656b085d6bafe95b9"><div class="ttname"><a href="group__gx2__debug.html#gga2d14451517a0f5ee0657435081bbe01ba298a91e9d3d4bc9656b085d6bafe95b9">GX2_DEBUG_CAPTURE_START_FLAGS_NONE</a></div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00024">debug.h:24</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_acd99bb05ca015e7d74448acb1deba7ca"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#acd99bb05ca015e7d74448acb1deba7ca">GX2DebugCaptureInterface::version</a></div><div class="ttdeci">uint32_t version</div><div class="ttdoc">Must be set to GX2_DEBUG_CAPTURE_INTERFACE_VERSION. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00041">debug.h:41</a></div></div>
<div class="ttc" id="structGX2DebugCaptureInterface_html_a68eb0161d4aad36e15c76dd1e30d4ef5"><div class="ttname"><a href="structGX2DebugCaptureInterface.html#a68eb0161d4aad36e15c76dd1e30d4ef5">GX2DebugCaptureInterface::onFree</a></div><div class="ttdeci">void(* onFree)(void *ptr)</div><div class="ttdoc">Called when GX2 memory is freed. </div><div class="ttdef"><b>Definition:</b> <a href="gx2_2debug_8h_source.html#l00063">debug.h:63</a></div></div>
<div class="ttc" id="group__gx2__debug_html_ga61eddc8c56303be08f8c8ab757956975"><div class="ttname"><a href="group__gx2__debug.html#ga61eddc8c56303be08f8c8ab757956975">GX2DebugCaptureEnd</a></div><div class="ttdeci">void GX2DebugCaptureEnd(GX2DebugCaptureEndFlags flags)</div><div class="ttdoc">Ends a debug capture. </div></div>
</div><!-- fragment --></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.14
</small></address>
</body>
</html>