SDL 2.0
SDL_test_common.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * \file SDL_test_common.h
24 *
25 * Include file for SDL test framework.
26 *
27 * This code is a part of the SDL2_test library, not the main SDL library.
28 */
29
30/* Ported from original test\common.h file. */
31
32#ifndef SDL_test_common_h_
33#define SDL_test_common_h_
34
35#include "SDL.h"
36
37#if defined(__PSP__)
38#define DEFAULT_WINDOW_WIDTH 480
39#define DEFAULT_WINDOW_HEIGHT 272
40#else
41#define DEFAULT_WINDOW_WIDTH 640
42#define DEFAULT_WINDOW_HEIGHT 480
43#endif
44
45#define VERBOSE_VIDEO 0x00000001
46#define VERBOSE_MODES 0x00000002
47#define VERBOSE_RENDER 0x00000004
48#define VERBOSE_EVENT 0x00000008
49#define VERBOSE_AUDIO 0x00000010
50
51typedef struct
52{
53 /* SDL init flags */
54 char **argv;
57
58 /* Video info */
59 const char *videodriver;
61 const char *window_title;
62 const char *window_icon;
74 float scale;
75 int depth;
79
80 /* Renderer info */
81 const char *renderdriver;
86
87 /* Audio info */
88 const char *audiodriver;
90
91 /* GL settings */
114
115#include "begin_code.h"
116/* Set up for C function definitions, even when using C++ */
117#ifdef __cplusplus
118extern "C" {
119#endif
120
121/* Function prototypes */
122
123/**
124 * \brief Parse command line parameters and create common state.
125 *
126 * \param argv Array of command line parameters
127 * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
128 *
129 * \returns Returns a newly allocated common state object.
130 */
132
133/**
134 * \brief Process one common argument.
135 *
136 * \param state The common state describing the test window to create.
137 * \param index The index of the argument to process in argv[].
138 *
139 * \returns The number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
140 */
142
143
144/**
145 * \brief Logs command line usage info.
146 *
147 * This logs the appropriate command line options for the subsystems in use
148 * plus other common options, and then any application-specific options.
149 * This uses the SDL_Log() function and splits up output to be friendly to
150 * 80-character-wide terminals.
151 *
152 * \param state The common state describing the test window for the app.
153 * \param argv0 argv[0], as passed to main/SDL_main.
154 * \param options an array of strings for application specific options. The last element of the array should be NULL.
155 */
156void SDLTest_CommonLogUsage(SDLTest_CommonState * state, const char *argv0, const char **options);
157
158/**
159 * \brief Open test window.
160 *
161 * \param state The common state describing the test window to create.
162 *
163 * \returns True if initialization succeeded, false otherwise
164 */
166
167/**
168 * \brief Easy argument handling when test app doesn't need any custom args.
169 *
170 * \param state The common state describing the test window to create.
171 * \param argc argc, as supplied to SDL_main
172 * \param argv argv, as supplied to SDL_main
173 *
174 * \returns False if app should quit, true otherwise.
175 */
176SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState * state, const int argc, char **argv);
177
178/**
179 * \brief Common event handler for test windows.
180 *
181 * \param state The common state used to create test window.
182 * \param event The event to handle.
183 * \param done Flag indicating we are done.
184 *
185 */
187
188/**
189 * \brief Close test window.
190 *
191 * \param state The common state used to create test window.
192 *
193 */
195
196
197/* Ends C function definitions when using C++ */
198#ifdef __cplusplus
199}
200#endif
201#include "close_code.h"
202
203#endif /* SDL_test_common_h_ */
204
205/* vi: set ts=4 sw=4 expandtab: */
struct _cl_event * event
GLuint index
GLbitfield flags
SDL_bool
Definition: SDL_stdinc.h:162
uint32_t Uint32
Definition: SDL_stdinc.h:203
void SDLTest_CommonQuit(SDLTest_CommonState *state)
Close test window.
SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, const int argc, char **argv)
Easy argument handling when test app doesn't need any custom args.
SDLTest_CommonState * SDLTest_CommonCreateState(char **argv, Uint32 flags)
Parse command line parameters and create common state.
void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done)
Common event handler for test windows.
int SDLTest_CommonArg(SDLTest_CommonState *state, int index)
Process one common argument.
SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state)
Open test window.
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options)
Logs command line usage info.
struct xkb_state * state
int done
Definition: checkkeys.c:28
The type used to identify a window.
Definition: SDL_sysvideo.h:74
SDL_Window ** windows
SDL_AudioSpec audiospec
SDL_Texture ** targets
const char * window_title
const char * videodriver
const char * window_icon
const char * renderdriver
const char * audiodriver
SDL_Renderer ** renderers
General event structure.
Definition: SDL_events.h:558