-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathannotated.html
119 lines (117 loc) · 14.6 KB
/
annotated.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libSDL2pp: Class List</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 id="projectrow">
<td id="projectalign">
<div id="projectname">libSDL2pp
</div>
<div id="projectbrief">C++ bindings/wrapper for SDL2</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">
<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">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><b>SDL2pp</b></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1AudioDevice.html" target="_self">AudioDevice</a></td><td class="desc">Audio device </td></tr>
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" target="_self">LockHandle</a></td><td class="desc"><a class="el" href="classSDL2pp_1_1AudioDevice.html" title="Audio device.">SDL2pp::AudioDevice</a> lock </td></tr>
<tr id="row_0_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1AudioSpec.html" target="_self">AudioSpec</a></td><td class="desc">Audio format specification </td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Chunk.html" target="_self">Chunk</a></td><td class="desc">Fragment of audio data </td></tr>
<tr id="row_0_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Color.html" target="_self">Color</a></td><td class="desc">RGB color with Alpha </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1ContainerRWops.html" target="_self">ContainerRWops</a></td><td class="desc"><a class="el" href="classSDL2pp_1_1RWops.html" title="I/O abstraction.">RWops</a> adaptor for random access STL containers </td></tr>
<tr id="row_0_5_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1CustomRWops.html" target="_self">CustomRWops</a></td><td class="desc">Base class for custom <a class="el" href="classSDL2pp_1_1RWops.html" title="I/O abstraction.">RWops</a> </td></tr>
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Exception.html" target="_self">Exception</a></td><td class="desc">Exception object representing SDL2 error </td></tr>
<tr id="row_0_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Font.html" target="_self">Font</a></td><td class="desc">Holder of a loaded font </td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Mixer.html" target="_self">Mixer</a></td><td class="desc">Audio mixer </td></tr>
<tr id="row_0_9_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Music.html" target="_self">Music</a></td><td class="desc">Music data </td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Point.html" target="_self">Point</a></td><td class="desc">2D point </td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Rect.html" target="_self">Rect</a></td><td class="desc">2D rectangle </td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Renderer.html" target="_self">Renderer</a></td><td class="desc">2D rendering context </td></tr>
<tr id="row_0_13_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1RWops.html" target="_self">RWops</a></td><td class="desc">I/O abstraction </td></tr>
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1SDL.html" target="_self">SDL</a></td><td class="desc">Helper class taking care of <a class="el" href="classSDL2pp_1_1SDL.html" title="Helper class taking care of SDL library initialization and deinitialization.">SDL</a> library initialization and deinitialization </td></tr>
<tr id="row_0_15_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1SDLImage.html" target="_self">SDLImage</a></td><td class="desc">Helper class taking care of SDL_image library initialization and deinitialization </td></tr>
<tr id="row_0_16_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1SDLMixer.html" target="_self">SDLMixer</a></td><td class="desc">Helper class taking care of SDL_mixer library initialization and deinitialization </td></tr>
<tr id="row_0_17_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1SDLTTF.html" target="_self">SDLTTF</a></td><td class="desc">Helper class taking care of SDL_ttf library initialization and deinitialization </td></tr>
<tr id="row_0_18_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1StreamRWops.html" target="_self">StreamRWops</a></td><td class="desc"><a class="el" href="classSDL2pp_1_1RWops.html" title="I/O abstraction.">RWops</a> adaptor for STL streams </td></tr>
<tr id="row_0_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_19_" class="arrow" onclick="toggleFolder('0_19_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Surface.html" target="_self">Surface</a></td><td class="desc">Image stored in system memory with direct access to pixel data </td></tr>
<tr id="row_0_19_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Surface_1_1LockHandle.html" target="_self">LockHandle</a></td><td class="desc"><a class="el" href="classSDL2pp_1_1Surface.html" title="Image stored in system memory with direct access to pixel data.">SDL2pp::Surface</a> lock </td></tr>
<tr id="row_0_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_20_" class="arrow" onclick="toggleFolder('0_20_')">▼</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Texture.html" target="_self">Texture</a></td><td class="desc">Image stored in the graphics card memory that can be used for fast drawing </td></tr>
<tr id="row_0_20_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Texture_1_1LockHandle.html" target="_self">LockHandle</a></td><td class="desc"><a class="el" href="classSDL2pp_1_1Texture.html" title="Image stored in the graphics card memory that can be used for fast drawing.">SDL2pp::Texture</a> lock </td></tr>
<tr id="row_0_21_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Wav.html" target="_self">Wav</a></td><td class="desc">Chunk of audio data read from a .WAV file </td></tr>
<tr id="row_0_22_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Window.html" target="_self">Window</a></td><td class="desc">GUI window object </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">▼</span><span class="icona"><span class="icon">N</span></span><b>std</b></td><td class="desc"></td></tr>
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01SDL2pp_1_1Color_01_4.html" target="_self">hash< SDL2pp::Color ></a></td><td class="desc">Std::hash specialization for <a class="el" href="classSDL2pp_1_1Color.html" title="RGB color with Alpha.">SDL2pp::Color</a> </td></tr>
<tr id="row_1_1_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01SDL2pp_1_1Point_01_4.html" target="_self">hash< SDL2pp::Point ></a></td><td class="desc">Std::hash specialization for <a class="el" href="classSDL2pp_1_1Rect.html" title="2D rectangle">SDL2pp::Rect</a> </td></tr>
<tr id="row_1_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1hash_3_01SDL2pp_1_1Rect_01_4.html" target="_self">hash< SDL2pp::Rect ></a></td><td class="desc">Std::hash specialization for <a class="el" href="classSDL2pp_1_1Rect.html" title="2D rectangle">SDL2pp::Rect</a> </td></tr>
<tr id="row_2_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1BadOptionalAccess.html" target="_self">BadOptionalAccess</a></td><td class="desc">Exception thrown on accessing a <a class="el" href="classSDL2pp_1_1Optional.html" title="Optional value container">SDL2pp::Optional</a> object with uninitialized state </td></tr>
<tr id="row_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classSDL2pp_1_1Optional.html" target="_self">Optional</a></td><td class="desc">Optional value container </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>