<!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"> <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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>My Project: SDL_main.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">My Project </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> </div><!-- top --> <!-- 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 class="header"> <div class="headertitle"> <div class="title">SDL_main.h</div> </div> </div><!--header--> <div class="contents"> <a href="SDL__main_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Simple DirectMedia Layer</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">*/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef SDL_main_h_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define SDL_main_h_</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="SDL__stdinc_8h.html">SDL_stdinc.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef SDL_MAIN_HANDLED</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#if defined(__WIN32__)</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/* On Windows SDL provides WinMain(), which parses the command line and passes</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> the arguments to your main function.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> If you provide your own WinMain(), you may define SDL_MAIN_HANDLED</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define SDL_MAIN_AVAILABLE</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#elif defined(__WINRT__)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/* On WinRT, SDL provides a main function that initializes CoreApplication,</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> creating an instance of IFrameworkView in the process.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> Please note that #include'ing SDL_main.h is not enough to get a main()</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> function working. In non-XAML apps, the file,</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> src/main/winrt/SDL_WinRT_main_NonXAML.cpp, or a copy of it, must be compiled</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> into the app itself. In XAML apps, the function, SDL_WinRTRunApp must be</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> called, with a pointer to the Direct3D-hosted XAML control passed in.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">*/</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define SDL_MAIN_NEEDED</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#elif defined(__IPHONEOS__)</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/* On iOS SDL provides a main function that creates an application delegate</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> and starts the iOS application run loop.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> If you link with SDL dynamically on iOS, the main function can't be in a</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> shared library, so you need to link with libSDLmain.a, which includes a</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> stub main function that calls into the shared library to start execution.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> See src/video/uikit/SDL_uikitappdelegate.m for more details.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> */</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#define SDL_MAIN_NEEDED</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#elif defined(__ANDROID__)</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/* On Android SDL provides a Java class in SDLActivity.java that is the</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> main activity entry point.</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> See docs/README-android.md for more details on extending that class.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#define SDL_MAIN_NEEDED</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/* We need to export SDL_main so it can be launched from Java */</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define SDLMAIN_DECLSPEC DECLSPEC</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#elif defined(__NACL__)</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/* On NACL we use ppapi_simple to set up the application helper code,</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> then wait for the first PSE_INSTANCE_DIDCHANGEVIEW event before </span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> starting the user main function.</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> All user code is run in a separate thread by ppapi_simple, thus </span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> allowing for blocking io to take place via nacl_io</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">*/</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#define SDL_MAIN_NEEDED</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif </span><span class="comment">/* SDL_MAIN_HANDLED */</span><span class="preprocessor"></span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor">#ifndef SDLMAIN_DECLSPEC</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor">#define SDLMAIN_DECLSPEC</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor">#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#define main SDL_main</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#include "<a class="code" href="begin__code_8h.html">begin_code.h</a>"</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="SDL__main_8h.html#a824db1a8625cd44144b424017466c4f9"> 120</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="SDL__main_8h.html#a824db1a8625cd44144b424017466c4f9">SDL_main_func</a>)(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="keyword">extern</span> SDLMAIN_DECLSPEC <span class="keywordtype">int</span> SDL_main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[]);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">extern</span> DECLSPEC <span class="keywordtype">void</span> SDLCALL <a class="code" href="SDL__main_8h.html#a6a4bb5ffb489bf0956bc1b813397306d">SDL_SetMainReady</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#ifdef __WIN32__</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="keyword">extern</span> DECLSPEC <span class="keywordtype">int</span> SDLCALL SDL_RegisterApp(<span class="keywordtype">char</span> *name, Uint32 style, <span class="keywordtype">void</span> *hInst);</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="keyword">extern</span> DECLSPEC <span class="keywordtype">void</span> SDLCALL SDL_UnregisterApp(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#endif </span><span class="comment">/* __WIN32__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#ifdef __WINRT__</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">extern</span> DECLSPEC <span class="keywordtype">int</span> SDLCALL SDL_WinRTRunApp(<a class="code" href="SDL__main_8h.html#a824db1a8625cd44144b424017466c4f9">SDL_main_func</a> mainFunction, <span class="keywordtype">void</span> * reserved);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#endif </span><span class="comment">/* __WINRT__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#if defined(__IPHONEOS__)</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="keyword">extern</span> DECLSPEC <span class="keywordtype">int</span> SDLCALL SDL_UIKitRunApp(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[], <a class="code" href="SDL__main_8h.html#a824db1a8625cd44144b424017466c4f9">SDL_main_func</a> mainFunction);</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor">#endif </span><span class="comment">/* __IPHONEOS__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> }</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor">#include "<a class="code" href="close__code_8h.html">close_code.h</a>"</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor">#endif </span><span class="comment">/* SDL_main_h_ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment">/* vi: set ts=4 sw=4 expandtab: */</span></div><div class="ttc" id="SDL__main_8h_html_a824db1a8625cd44144b424017466c4f9"><div class="ttname"><a href="SDL__main_8h.html#a824db1a8625cd44144b424017466c4f9">SDL_main_func</a></div><div class="ttdeci">int(* SDL_main_func)(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> SDL_main.h:120</div></div> <div class="ttc" id="begin__code_8h_html"><div class="ttname"><a href="begin__code_8h.html">begin_code.h</a></div></div> <div class="ttc" id="SDL__stdinc_8h_html"><div class="ttname"><a href="SDL__stdinc_8h.html">SDL_stdinc.h</a></div></div> <div class="ttc" id="SDL__main_8h_html_a6a4bb5ffb489bf0956bc1b813397306d"><div class="ttname"><a href="SDL__main_8h.html#a6a4bb5ffb489bf0956bc1b813397306d">SDL_SetMainReady</a></div><div class="ttdeci">DECLSPEC void SDLCALL SDL_SetMainReady(void)</div></div> <div class="ttc" id="close__code_8h_html"><div class="ttname"><a href="close__code_8h.html">close_code.h</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>