this repo has no description
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.6"/>
7<title>Renderer Setup</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="search/search.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="search/search.js"></script>
13<script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
15</script>
16<link href="doxygen.css" rel="stylesheet" type="text/css" />
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<!-- end header part -->
21<!-- Generated by Doxygen 1.8.6 -->
22<script type="text/javascript">
23var searchBox = new SearchBox("searchBox", "search",false,'Search');
24</script>
25 <div id="navrow1" class="tabs">
26 <ul class="tablist">
27 <li><a href="index.html"><span>Main Page</span></a></li>
28 <li><a href="modules.html"><span>Modules</span></a></li>
29 <li><a href="annotated.html"><span>Classes</span></a></li>
30 <li><a href="files.html"><span>Files</span></a></li>
31 <li>
32 <div id="MSearchBox" class="MSearchBoxInactive">
33 <span class="left">
34 <img id="MSearchSelect" src="search/mag_sel.png"
35 onmouseover="return searchBox.OnSearchSelectShow()"
36 onmouseout="return searchBox.OnSearchSelectHide()"
37 alt=""/>
38 <input type="text" id="MSearchField" value="Search" accesskey="S"
39 onfocus="searchBox.OnSearchFieldFocus(true)"
40 onblur="searchBox.OnSearchFieldFocus(false)"
41 onkeyup="searchBox.OnSearchFieldChange(event)"/>
42 </span><span class="right">
43 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
44 </span>
45 </div>
46 </li>
47 </ul>
48 </div>
49</div><!-- top -->
50<!-- window showing the filter options -->
51<div id="MSearchSelectWindow"
52 onmouseover="return searchBox.OnSearchSelectShow()"
53 onmouseout="return searchBox.OnSearchSelectHide()"
54 onkeydown="return searchBox.OnSearchSelectKey(event)">
55<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Groups</a></div>
56
57<!-- iframe showing the search results (closed by default) -->
58<div id="MSearchResultsWindow">
59<iframe src="javascript:void(0)" frameborder="0"
60 name="MSearchResults" id="MSearchResults">
61</iframe>
62</div>
63
64<div class="header">
65 <div class="summary">
66<a href="#nested-classes">Classes</a> </div>
67 <div class="headertitle">
68<div class="title">Renderer Setup</div> </div>
69</div><!--header-->
70<div class="contents">
71<div class="dynheader">
72Collaboration diagram for Renderer Setup:</div>
73<div class="dyncontent">
74<center><table><tr><td><img src="group__RendererSetup.png" border="0" alt="" usemap="#group____RendererSetup"/>
75<map name="group____RendererSetup" id="group____RendererSetup">
76<area shape="rect" id="node1" href="group__Initialization.html" title="Initialization" alt="" coords="291,5,381,32"/><area shape="rect" id="node3" href="group__RendererControls.html" title="Renderer Controls" alt="" coords="272,56,400,83"/></map>
77</td></tr></table></center>
78</div>
79<table class="memberdecls">
80<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
81Classes</h2></td></tr>
82<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structGPU__RendererID.html">GPU_RendererID</a></td></tr>
83<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
84<tr class="memitem:ga6a2ba74f6c1ccd08517393014bf800c5"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RendererSetup.html#ga6a2ba74f6c1ccd08517393014bf800c5">GPU_MakeRendererID</a> (const char *name, GPU_RendererEnum renderer, int major_version, int minor_version)</td></tr>
85<tr class="separator:ga6a2ba74f6c1ccd08517393014bf800c5"><td class="memSeparator" colspan="2"> </td></tr>
86<tr class="memitem:ga87d32db4fb5b83c4831ec0eec244fb84"><td class="memItemLeft" align="right" valign="top">DECLSPEC <a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RendererSetup.html#ga87d32db4fb5b83c4831ec0eec244fb84">GPU_GetRendererID</a> (GPU_RendererEnum renderer)</td></tr>
87<tr class="separator:ga87d32db4fb5b83c4831ec0eec244fb84"><td class="memSeparator" colspan="2"> </td></tr>
88<tr class="memitem:gaaf741e65f12e64a46f59ecc194d92a83"><td class="memItemLeft" align="right" valign="top">DECLSPEC int SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RendererSetup.html#gaaf741e65f12e64a46f59ecc194d92a83">GPU_GetNumRegisteredRenderers</a> (void)</td></tr>
89<tr class="separator:gaaf741e65f12e64a46f59ecc194d92a83"><td class="memSeparator" colspan="2"> </td></tr>
90<tr class="memitem:ga32704a11d5d72b8233eabb188e094a59"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RendererSetup.html#ga32704a11d5d72b8233eabb188e094a59">GPU_GetRegisteredRendererList</a> (<a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> *renderers_array)</td></tr>
91<tr class="separator:ga32704a11d5d72b8233eabb188e094a59"><td class="memSeparator" colspan="2"> </td></tr>
92<tr class="memitem:gaafad0c63e3dd7942d730741b6977cdc0"><td class="memItemLeft" align="right" valign="top">DECLSPEC void SDLCALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__RendererSetup.html#gaafad0c63e3dd7942d730741b6977cdc0">GPU_RegisterRenderer</a> (<a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> id, <a class="el" href="structGPU__Renderer.html">GPU_Renderer</a> *(SDLCALL *create_renderer)(<a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> request), void(SDLCALL *free_renderer)(<a class="el" href="structGPU__Renderer.html">GPU_Renderer</a> *renderer))</td></tr>
93<tr class="separator:gaafad0c63e3dd7942d730741b6977cdc0"><td class="memSeparator" colspan="2"> </td></tr>
94</table>
95<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
96<h2 class="groupheader">Function Documentation</h2>
97<a class="anchor" id="gaaf741e65f12e64a46f59ecc194d92a83"></a>
98<div class="memitem">
99<div class="memproto">
100 <table class="memname">
101 <tr>
102 <td class="memname">DECLSPEC int SDLCALL GPU_GetNumRegisteredRenderers </td>
103 <td>(</td>
104 <td class="paramtype">void </td>
105 <td class="paramname"></td><td>)</td>
106 <td></td>
107 </tr>
108 </table>
109</div><div class="memdoc">
110<p>Gets the number of registered (available) renderers. </p>
111
112</div>
113</div>
114<a class="anchor" id="ga32704a11d5d72b8233eabb188e094a59"></a>
115<div class="memitem">
116<div class="memproto">
117 <table class="memname">
118 <tr>
119 <td class="memname">DECLSPEC void SDLCALL GPU_GetRegisteredRendererList </td>
120 <td>(</td>
121 <td class="paramtype"><a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> * </td>
122 <td class="paramname"><em>renderers_array</em></td><td>)</td>
123 <td></td>
124 </tr>
125 </table>
126</div><div class="memdoc">
127<p>Gets an array of identifiers for the registered (available) renderers. </p>
128
129</div>
130</div>
131<a class="anchor" id="ga87d32db4fb5b83c4831ec0eec244fb84"></a>
132<div class="memitem">
133<div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">DECLSPEC <a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> SDLCALL GPU_GetRendererID </td>
137 <td>(</td>
138 <td class="paramtype">GPU_RendererEnum </td>
139 <td class="paramname"><em>renderer</em></td><td>)</td>
140 <td></td>
141 </tr>
142 </table>
143</div><div class="memdoc">
144<p>Gets the first registered renderer identifier for the given enum value. </p>
145
146</div>
147</div>
148<a class="anchor" id="ga6a2ba74f6c1ccd08517393014bf800c5"></a>
149<div class="memitem">
150<div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">DECLSPEC <a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> SDLCALL GPU_MakeRendererID </td>
154 <td>(</td>
155 <td class="paramtype">const char * </td>
156 <td class="paramname"><em>name</em>, </td>
157 </tr>
158 <tr>
159 <td class="paramkey"></td>
160 <td></td>
161 <td class="paramtype">GPU_RendererEnum </td>
162 <td class="paramname"><em>renderer</em>, </td>
163 </tr>
164 <tr>
165 <td class="paramkey"></td>
166 <td></td>
167 <td class="paramtype">int </td>
168 <td class="paramname"><em>major_version</em>, </td>
169 </tr>
170 <tr>
171 <td class="paramkey"></td>
172 <td></td>
173 <td class="paramtype">int </td>
174 <td class="paramname"><em>minor_version</em> </td>
175 </tr>
176 <tr>
177 <td></td>
178 <td>)</td>
179 <td></td><td></td>
180 </tr>
181 </table>
182</div><div class="memdoc">
183<p>Returns an initialized <a class="el" href="structGPU__RendererID.html">GPU_RendererID</a>. </p>
184
185</div>
186</div>
187<a class="anchor" id="gaafad0c63e3dd7942d730741b6977cdc0"></a>
188<div class="memitem">
189<div class="memproto">
190 <table class="memname">
191 <tr>
192 <td class="memname">DECLSPEC void SDLCALL GPU_RegisterRenderer </td>
193 <td>(</td>
194 <td class="paramtype"><a class="el" href="structGPU__RendererID.html">GPU_RendererID</a> </td>
195 <td class="paramname"><em>id</em>, </td>
196 </tr>
197 <tr>
198 <td class="paramkey"></td>
199 <td></td>
200 <td class="paramtype"><a class="el" href="structGPU__Renderer.html">GPU_Renderer</a> * </td>
201 <td class="paramname">SDLCALL *create_renderer)(GPU_RendererID request, </td>
202 </tr>
203 <tr>
204 <td class="paramkey"></td>
205 <td></td>
206 <td class="paramtype">void(SDLCALL *free_renderer)(<a class="el" href="structGPU__Renderer.html">GPU_Renderer</a> *renderer) </td>
207 <td class="paramname"> </td>
208 </tr>
209 <tr>
210 <td></td>
211 <td>)</td>
212 <td></td><td></td>
213 </tr>
214 </table>
215</div><div class="memdoc">
216<p>Prepares a renderer for use by SDL_gpu. </p>
217
218</div>
219</div>
220</div><!-- contents -->
221<!-- start footer part -->
222<hr class="footer"/><address class="footer"><small>
223Generated by  <a href="http://www.doxygen.org/index.html">
224<img class="footer" src="doxygen.png" alt="doxygen"/>
225</a> 1.8.6
226</small></address>
227</body>
228</html>