2 Simple DirectMedia Layer
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.
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:
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.
23 * \file SDL_test_common.h
25 * Include file for SDL test framework.
27 * This code is a part of the SDL2_test library, not the main SDL library.
30 /* Ported from original test\common.h file. */
32 #ifndef _SDL_test_common_h
33 #define _SDL_test_common_h
38 #define DEFAULT_WINDOW_WIDTH 480
39 #define DEFAULT_WINDOW_HEIGHT 272
41 #define DEFAULT_WINDOW_WIDTH 640
42 #define DEFAULT_WINDOW_HEIGHT 480
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
59 const char *videodriver;
61 const char *window_title;
62 const char *window_icon;
81 const char *renderdriver;
83 SDL_bool skip_renderer;
84 SDL_Renderer **renderers;
85 SDL_Texture **targets;
88 const char *audiodriver;
89 SDL_AudioSpec audiospec;
100 int gl_accum_red_size;
101 int gl_accum_green_size;
102 int gl_accum_blue_size;
103 int gl_accum_alpha_size;
105 int gl_multisamplebuffers;
106 int gl_multisamplesamples;
107 int gl_retained_backing;
109 int gl_major_version;
110 int gl_minor_version;
113 } SDLTest_CommonState;
115 #include "begin_code.h"
116 /* Set up for C function definitions, even when using C++ */
121 /* Function prototypes */
124 * \brief Parse command line parameters and create common state.
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)
129 * \returns Returns a newly allocated common state object.
131 SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
134 * \brief Process one common argument.
136 * \param state The common state describing the test window to create.
137 * \param index The index of the argument to process in argv[].
139 * \returns The number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
141 int SDLTest_CommonArg(SDLTest_CommonState * state, int index);
144 * \brief Returns common usage information
146 * \param state The common state describing the test window to create.
148 * \returns String with usage information
150 const char *SDLTest_CommonUsage(SDLTest_CommonState * state);
153 * \brief Open test window.
155 * \param state The common state describing the test window to create.
157 * \returns True if initialization succeeded, false otherwise
159 SDL_bool SDLTest_CommonInit(SDLTest_CommonState * state);
162 * \brief Common event handler for test windows.
164 * \param state The common state used to create test window.
165 * \param event The event to handle.
166 * \param done Flag indicating we are done.
169 void SDLTest_CommonEvent(SDLTest_CommonState * state, SDL_Event * event, int *done);
172 * \brief Close test window.
174 * \param state The common state used to create test window.
177 void SDLTest_CommonQuit(SDLTest_CommonState * state);
180 /* Ends C function definitions when using C++ */
184 #include "close_code.h"
186 #endif /* _SDL_test_common_h */
188 /* vi: set ts=4 sw=4 expandtab: */