lexsdl 0.3.0

A wrapper for SDL2 to abstract away annoying parts
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

<!DOCTYPE html>
<html lang="en">
<head>
	<title>LEXSDL_Init</title>
	<link rel="stylesheet" href="styles.css">
</head>
<header>
	<h1>LEXSDL_Init</h1>
	<hr>
</header>
<body>
	<p>
		Initialises SDL with the desired flags or default ones.<br>
	</p>
	<p>
		A full list of init flags and info on Initializing SDL can be found in the <a href=https://wiki.libsdl.org/SDL2/SDL_Init>SDL Documentation</a>.<br>
		The normal <a href=https://wiki.libsdl.org/SDL2/SDL_Init>SDL_Init<span style=color:#66cf8d>()</span></a> can be used without problems but <a href=LEXSDL_SetupEvents.html>LEXSDL_SetupEvents<span style=color:#66cf8d>()</span></a> will need to be manually called since it is implicitly called with LEXSDL_Init<span style=color:#66cf8d>()</span>.<br>
		LEXSDL_SetupEvents() could fail in a extreme case and the fixed error is <span style=color:#66cf8d>-</span><span style=color:#f67400>1</span><span style=color:#66cf8d>;</span><br>
	</p>
	<h2>Function</h2>
	<p><code><ul>
		<a style="color:#2980b9">int</a> LEXSDL_Init<a style="color:#66cf8d">(</a><a style="color:#2980b9">uint32_t</a> flags<a  style="color:#66cf8d">);</a>
	</ul></code></p>
	<h2>Return</h2>
		<ul>
				<a style="color:#66cf8d">*</a><b>Note</b> : If a error ocurres call <a href=https://wiki.libsdl.org/SDL2/SDL_GetError>SDL_GetError<a href=https://wiki.libsdl.org/SDL2/SDL_GetError style="color:#66cf8d">()</a></a> for more information.<br>
				&nbsp;<a style="color:#f67400">0</a><a style="color:#66cf8d">:</a> Initialization was succesfull.<br>
				&nbsp;*negative number*<a style="color:#66cf8d">:</a> Initialization failed.
		</ul>
	<h2>Parameters</h2>
	<p><ul>
		<b>flags</b> : if set to <a style="color:#f67400">0</a> it will use the <a href=LEXSDL_Init.html#defaults> default flags</a>.
	</ul></p>
	<h2 id=defaults>Implicit Calls</h2>
	<ul>
		<a href=LEXSDL_SetupEvents.html>LEXSDL_SetupEvents<span style=color:#66cf8d>()</span></a><span style=color:#66cf8d>;</span><br>
	</ul>
	<h2 id=defaults>Defaults</h2>
	<ul>
		LEXSDL_INITFLAGS = <a href=https://wiki.libsdl.org/SDL2/SDL_Init>SDL_INIT_VIDEO</a>
	</ul>
</body>
<footer>
	<br>
	<hr>
	<a href=FrontPage.html>FrontPage</a> <b>|</b> <a href=https://gitlab.com/Alexevier/lexsdl>GitLab</a> <b>|</b> <a href=https://crates.io/crates/lexsdl>Crates.io</a>
</footer>
</html>