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 
51 typedef struct
52 {
53  /* SDL init flags */
54  char **argv;
57 
58  /* Video info */
59  const char *videodriver;
60  int display;
61  const char *window_title;
62  const char *window_icon;
64  int window_x;
65  int window_y;
66  int window_w;
67  int window_h;
72  int logical_w;
73  int logical_h;
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 */
111  int gl_debug;
114 
115 #include "begin_code.h"
116 /* Set up for C function definitions, even when using C++ */
117 #ifdef __cplusplus
118 extern "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  */
156 void 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  */
176 SDL_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: */
SDL.h
SDLTest_CommonState::windows
SDL_Window ** windows
Definition: SDL_test_common.h:78
SDLTest_CommonState::gl_stencil_size
int gl_stencil_size
Definition: SDL_test_common.h:98
SDLTest_CommonState::targets
SDL_Texture ** targets
Definition: SDL_test_common.h:85
SDLTest_CommonState::gl_depth_size
int gl_depth_size
Definition: SDL_test_common.h:97
SDLTest_CommonState::gl_minor_version
int gl_minor_version
Definition: SDL_test_common.h:110
SDLTest_CommonState::gl_red_size
int gl_red_size
Definition: SDL_test_common.h:92
SDLTest_CommonState::gl_accum_blue_size
int gl_accum_blue_size
Definition: SDL_test_common.h:102
SDLTest_CommonState::display
int display
Definition: SDL_test_common.h:60
SDLTest_CommonState::render_flags
Uint32 render_flags
Definition: SDL_test_common.h:82
SDLTest_CommonState::scale
float scale
Definition: SDL_test_common.h:74
SDLTest_CommonState::gl_stereo
int gl_stereo
Definition: SDL_test_common.h:104
SDLTest_CommonState::gl_buffer_size
int gl_buffer_size
Definition: SDL_test_common.h:96
SDLTest_CommonState
Definition: SDL_test_common.h:51
SDLTest_CommonState::gl_multisamplebuffers
int gl_multisamplebuffers
Definition: SDL_test_common.h:105
SDLTest_CommonState::gl_retained_backing
int gl_retained_backing
Definition: SDL_test_common.h:107
SDLTest_CommonState::gl_accum_alpha_size
int gl_accum_alpha_size
Definition: SDL_test_common.h:103
SDLTest_CommonState::skip_renderer
SDL_bool skip_renderer
Definition: SDL_test_common.h:83
SDLTest_CommonState::window_icon
const char * window_icon
Definition: SDL_test_common.h:62
SDLTest_CommonState::gl_debug
int gl_debug
Definition: SDL_test_common.h:111
SDLTest_CommonState::window_minW
int window_minW
Definition: SDL_test_common.h:68
SDL_AudioSpec
Definition: SDL_audio.h:178
SDLTest_CommonState::gl_accum_red_size
int gl_accum_red_size
Definition: SDL_test_common.h:100
SDLTest_CommonState::depth
int depth
Definition: SDL_test_common.h:75
SDLTest_CommonState::gl_major_version
int gl_major_version
Definition: SDL_test_common.h:109
index
GLuint index
Definition: SDL_opengl_glext.h:660
SDLTest_CommonState::gl_green_size
int gl_green_size
Definition: SDL_test_common.h:93
SDLTest_CommonState::renderers
SDL_Renderer ** renderers
Definition: SDL_test_common.h:84
close_code.h
SDLTest_CommonState::window_y
int window_y
Definition: SDL_test_common.h:65
SDLTest_CommonCreateState
SDLTest_CommonState * SDLTest_CommonCreateState(char **argv, Uint32 flags)
Parse command line parameters and create common state.
Definition: SDL_test_common.c:59
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:73
SDLTest_CommonState::logical_h
int logical_h
Definition: SDL_test_common.h:73
begin_code.h
SDLTest_CommonQuit
void SDLTest_CommonQuit(SDLTest_CommonState *state)
Close test window.
Definition: SDL_test_common.c:1832
SDLTest_CommonState::window_w
int window_w
Definition: SDL_test_common.h:66
SDLTest_CommonState::gl_alpha_size
int gl_alpha_size
Definition: SDL_test_common.h:95
SDLTest_CommonState::window_x
int window_x
Definition: SDL_test_common.h:64
SDLTest_CommonState::gl_profile_mask
int gl_profile_mask
Definition: SDL_test_common.h:112
SDLTest_CommonState::num_windows
int num_windows
Definition: SDL_test_common.h:77
event
struct _cl_event * event
Definition: SDL_opengl_glext.h:2649
SDL_Renderer
Definition: SDL_sysrender.h:122
done
int done
Definition: checkkeys.c:28
SDLTest_CommonDefaultArgs
SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, const int argc, char **argv)
Easy argument handling when test app doesn't need any custom args.
Definition: SDL_test_common.c:516
SDLTest_CommonState::audiodriver
const char * audiodriver
Definition: SDL_test_common.h:88
SDLTest_CommonArg
int SDLTest_CommonArg(SDLTest_CommonState *state, int index)
Process one common argument.
Definition: SDL_test_common.c:117
SDLTest_CommonState::window_maxH
int window_maxH
Definition: SDL_test_common.h:71
SDLTest_CommonState::gl_blue_size
int gl_blue_size
Definition: SDL_test_common.h:94
SDLTest_CommonLogUsage
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options)
Logs command line usage info.
Definition: SDL_test_common.c:489
SDLTest_CommonState::flags
Uint32 flags
Definition: SDL_test_common.h:55
SDLTest_CommonState::window_maxW
int window_maxW
Definition: SDL_test_common.h:70
SDLTest_CommonState::argv
char ** argv
Definition: SDL_test_common.h:54
SDLTest_CommonState::audiospec
SDL_AudioSpec audiospec
Definition: SDL_test_common.h:89
SDLTest_CommonState::refresh_rate
int refresh_rate
Definition: SDL_test_common.h:76
SDLTest_CommonInit
SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state)
Open test window.
Definition: SDL_test_common.c:764
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:161
SDLTest_CommonState::window_title
const char * window_title
Definition: SDL_test_common.h:61
SDLTest_CommonState::window_flags
Uint32 window_flags
Definition: SDL_test_common.h:63
SDLTest_CommonState::logical_w
int logical_w
Definition: SDL_test_common.h:72
SDLTest_CommonState::gl_accelerated
int gl_accelerated
Definition: SDL_test_common.h:108
SDLTest_CommonState::videodriver
const char * videodriver
Definition: SDL_test_common.h:59
SDL_Texture
Definition: SDL_sysrender.h:43
SDLTest_CommonState::window_h
int window_h
Definition: SDL_test_common.h:67
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
SDLTest_CommonState::window_minH
int window_minH
Definition: SDL_test_common.h:69
SDLTest_CommonState::gl_multisamplesamples
int gl_multisamplesamples
Definition: SDL_test_common.h:106
SDL_Event
General event structure.
Definition: SDL_events.h:557
SDLTest_CommonEvent
void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done)
Common event handler for test windows.
Definition: SDL_test_common.c:1501
SDLTest_CommonState::gl_accum_green_size
int gl_accum_green_size
Definition: SDL_test_common.h:101
flags
GLbitfield flags
Definition: SDL_opengl_glext.h:1480
SDLTest_CommonState::gl_double_buffer
int gl_double_buffer
Definition: SDL_test_common.h:99
state
struct xkb_state * state
Definition: SDL_waylandsym.h:113
SDLTest_CommonState::verbose
Uint32 verbose
Definition: SDL_test_common.h:56
SDLTest_CommonState::renderdriver
const char * renderdriver
Definition: SDL_test_common.h:81