The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-08 14:50:45 +01:00
Code Issues Packages Projects Releases Wiki Activity
0dce43b98d
wut/structGX2DebugCaptureInterface.html
Ash 0dce43b98d
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00

347 lines
20 KiB
HTML
Raw Blame History

<!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: GX2DebugCaptureInterface Struct 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>
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">GX2DebugCaptureInterface Struct Reference<div class="ingroups"><a class="el" href="group__gx2.html">gx2</a> &raquo; <a class="el" href="group__gx2__debug.html">Debug</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="gx2_2debug_8h_source.html">include/gx2/debug.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acd99bb05ca015e7d74448acb1deba7ca"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#acd99bb05ca015e7d74448acb1deba7ca">version</a></td></tr>
<tr class="memdesc:acd99bb05ca015e7d74448acb1deba7ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Must be set to GX2_DEBUG_CAPTURE_INTERFACE_VERSION. <a href="#acd99bb05ca015e7d74448acb1deba7ca">More...</a><br /></td></tr>
<tr class="separator:acd99bb05ca015e7d74448acb1deba7ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdd52ac850766c51c16e85f0a9a65d27"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#afdd52ac850766c51c16e85f0a9a65d27">onShutdown</a> )()</td></tr>
<tr class="memdesc:afdd52ac850766c51c16e85f0a9a65d27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2Shutdown. <a href="#afdd52ac850766c51c16e85f0a9a65d27">More...</a><br /></td></tr>
<tr class="separator:afdd52ac850766c51c16e85f0a9a65d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac553cbbb1ead51f0325bd2395a72ff34"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#ac553cbbb1ead51f0325bd2395a72ff34">setAllocator</a> )()</td></tr>
<tr class="memdesc:ac553cbbb1ead51f0325bd2395a72ff34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2DebugSetCaptureInterface with the default gx2 allocators. <a href="#ac553cbbb1ead51f0325bd2395a72ff34">More...</a><br /></td></tr>
<tr class="separator:ac553cbbb1ead51f0325bd2395a72ff34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7522f6441e19fb80cdb4b21da744fafb"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#a7522f6441e19fb80cdb4b21da744fafb">onCaptureStart</a> )(const char *filename)</td></tr>
<tr class="memdesc:a7522f6441e19fb80cdb4b21da744fafb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2DebugCaptureStart, the filename is first argument passed in to GX2DebugCaptureStart. <a href="#a7522f6441e19fb80cdb4b21da744fafb">More...</a><br /></td></tr>
<tr class="separator:a7522f6441e19fb80cdb4b21da744fafb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1619e28c113273e87bf2339bcd1c5b94"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#a1619e28c113273e87bf2339bcd1c5b94">onCaptureEnd</a> )()</td></tr>
<tr class="memdesc:a1619e28c113273e87bf2339bcd1c5b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2DebugCaptureEnd. <a href="#a1619e28c113273e87bf2339bcd1c5b94">More...</a><br /></td></tr>
<tr class="separator:a1619e28c113273e87bf2339bcd1c5b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ad1a11f9b97259ab856807f1a5f5c49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#a0ad1a11f9b97259ab856807f1a5f5c49">isCaptureEnabled</a> )()</td></tr>
<tr class="memdesc:a0ad1a11f9b97259ab856807f1a5f5c49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if capture is enabled. <a href="#a0ad1a11f9b97259ab856807f1a5f5c49">More...</a><br /></td></tr>
<tr class="separator:a0ad1a11f9b97259ab856807f1a5f5c49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e670e5f59c71a4799069540f606a80d"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#a8e670e5f59c71a4799069540f606a80d">onAlloc</a> )(void *ptr, uint32_t size, uint32_t align)</td></tr>
<tr class="memdesc:a8e670e5f59c71a4799069540f606a80d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when GX2 memory is allocated. <a href="#a8e670e5f59c71a4799069540f606a80d">More...</a><br /></td></tr>
<tr class="separator:a8e670e5f59c71a4799069540f606a80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68eb0161d4aad36e15c76dd1e30d4ef5"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#a68eb0161d4aad36e15c76dd1e30d4ef5">onFree</a> )(void *ptr)</td></tr>
<tr class="memdesc:a68eb0161d4aad36e15c76dd1e30d4ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when GX2 memory is freed. <a href="#a68eb0161d4aad36e15c76dd1e30d4ef5">More...</a><br /></td></tr>
<tr class="separator:a68eb0161d4aad36e15c76dd1e30d4ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6e1c45ba923a88daa34e7c47489be57"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#aa6e1c45ba923a88daa34e7c47489be57">onUnknownMemory</a> )(void *ptr, uint32_t size)</td></tr>
<tr class="memdesc:aa6e1c45ba923a88daa34e7c47489be57"><td class="mdescLeft">&#160;</td><td class="mdescRight">UNKNOWN: Called when something happens with some memory. <a href="#aa6e1c45ba923a88daa34e7c47489be57">More...</a><br /></td></tr>
<tr class="separator:aa6e1c45ba923a88daa34e7c47489be57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e11ccf77aff665312b7998d06358a8"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#ab4e11ccf77aff665312b7998d06358a8">setOutputSurface</a> )(<a class="el" href="group__gx2__surface.html#structGX2Surface">GX2Surface</a> *surface)</td></tr>
<tr class="memdesc:ab4e11ccf77aff665312b7998d06358a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2DebugCaptureStart with the TV scan buffer. <a href="#ab4e11ccf77aff665312b7998d06358a8">More...</a><br /></td></tr>
<tr class="separator:ab4e11ccf77aff665312b7998d06358a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2b47e53aa2504d49c12ead678e71d48"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#af2b47e53aa2504d49c12ead678e71d48">onSwapScanBuffers</a> )(<a class="el" href="group__gx2__surface.html#structGX2Surface">GX2Surface</a> *surface)</td></tr>
<tr class="memdesc:af2b47e53aa2504d49c12ead678e71d48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called from GX2SwapScanBuffers with the TV scan buffer. <a href="#af2b47e53aa2504d49c12ead678e71d48">More...</a><br /></td></tr>
<tr class="separator:af2b47e53aa2504d49c12ead678e71d48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1b811e21e2714b747df75c48c7d06ab"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGX2DebugCaptureInterface.html#ae1b811e21e2714b747df75c48c7d06ab">submitToRing</a> )(void *unk1, uint32_t unk2, uint32_t *unk3, uint64_t *outSubmitTimestamp)</td></tr>
<tr class="memdesc:ae1b811e21e2714b747df75c48c7d06ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a command buffer is ready to be submitted to ring buffer. <a href="#ae1b811e21e2714b747df75c48c7d06ab">More...</a><br /></td></tr>
<tr class="separator:ae1b811e21e2714b747df75c48c7d06ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00038">38</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="acd99bb05ca015e7d74448acb1deba7ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd99bb05ca015e7d74448acb1deba7ca">&#9670;&nbsp;</a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Must be set to GX2_DEBUG_CAPTURE_INTERFACE_VERSION. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00041">41</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="afdd52ac850766c51c16e85f0a9a65d27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdd52ac850766c51c16e85f0a9a65d27">&#9670;&nbsp;</a></span>onShutdown</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onShutdown) ()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2Shutdown. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00044">44</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="ac553cbbb1ead51f0325bd2395a72ff34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac553cbbb1ead51f0325bd2395a72ff34">&#9670;&nbsp;</a></span>setAllocator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* setAllocator) ()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2DebugSetCaptureInterface with the default gx2 allocators. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00047">47</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="a7522f6441e19fb80cdb4b21da744fafb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7522f6441e19fb80cdb4b21da744fafb">&#9670;&nbsp;</a></span>onCaptureStart</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onCaptureStart) (const char *filename)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2DebugCaptureStart, the filename is first argument passed in to GX2DebugCaptureStart. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00051">51</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="a1619e28c113273e87bf2339bcd1c5b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1619e28c113273e87bf2339bcd1c5b94">&#9670;&nbsp;</a></span>onCaptureEnd</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onCaptureEnd) ()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2DebugCaptureEnd. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00054">54</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="a0ad1a11f9b97259ab856807f1a5f5c49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad1a11f9b97259ab856807f1a5f5c49">&#9670;&nbsp;</a></span>isCaptureEnabled</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>(* isCaptureEnabled) ()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if capture is enabled. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00057">57</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="a8e670e5f59c71a4799069540f606a80d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e670e5f59c71a4799069540f606a80d">&#9670;&nbsp;</a></span>onAlloc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onAlloc) (void *ptr, uint32_t size, uint32_t align)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when GX2 memory is allocated. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00060">60</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="a68eb0161d4aad36e15c76dd1e30d4ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68eb0161d4aad36e15c76dd1e30d4ef5">&#9670;&nbsp;</a></span>onFree</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onFree) (void *ptr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when GX2 memory is freed. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00063">63</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="aa6e1c45ba923a88daa34e7c47489be57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6e1c45ba923a88daa34e7c47489be57">&#9670;&nbsp;</a></span>onUnknownMemory</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onUnknownMemory) (void *ptr, uint32_t size)</td>
</tr>
</table>
</div><div class="memdoc">
<p>UNKNOWN: Called when something happens with some memory. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00066">66</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="ab4e11ccf77aff665312b7998d06358a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4e11ccf77aff665312b7998d06358a8">&#9670;&nbsp;</a></span>setOutputSurface</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* setOutputSurface) (<a class="el" href="group__gx2__surface.html#structGX2Surface">GX2Surface</a> *surface)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2DebugCaptureStart with the TV scan buffer. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00069">69</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="af2b47e53aa2504d49c12ead678e71d48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2b47e53aa2504d49c12ead678e71d48">&#9670;&nbsp;</a></span>onSwapScanBuffers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* onSwapScanBuffers) (<a class="el" href="group__gx2__surface.html#structGX2Surface">GX2Surface</a> *surface)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called from GX2SwapScanBuffers with the TV scan buffer. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00072">72</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<a id="ae1b811e21e2714b747df75c48c7d06ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b811e21e2714b747df75c48c7d06ab">&#9670;&nbsp;</a></span>submitToRing</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* submitToRing) (void *unk1, uint32_t unk2, uint32_t *unk3, uint64_t *outSubmitTimestamp)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a command buffer is ready to be submitted to ring buffer. </p>
<p>Note that it seems we must call TCLSubmitToRing from this callback because gx2 will not do it when capturing. </p>
<p class="definition">Definition at line <a class="el" href="gx2_2debug_8h_source.html#l00077">77</a> of file <a class="el" href="gx2_2debug_8h_source.html">debug.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/gx2/<a class="el" href="gx2_2debug_8h_source.html">debug.h</a></li>
</ul>
</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>
Reference in New Issue View Git Blame Copy Permalink