SDL 3.0
SDL_test_common.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2024 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 * Common functions of SDL test framework.
26 *
27 * This code is a part of the SDL 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 <SDL3/SDL.h>
36
37#ifdef SDL_PLATFORM_PSP
38#define DEFAULT_WINDOW_WIDTH 480
39#define DEFAULT_WINDOW_HEIGHT 272
40#elif defined(SDL_PLATFORM_VITA)
41#define DEFAULT_WINDOW_WIDTH 960
42#define DEFAULT_WINDOW_HEIGHT 544
43#else
44#define DEFAULT_WINDOW_WIDTH 640
45#define DEFAULT_WINDOW_HEIGHT 480
46#endif
47
49#define VERBOSE_VIDEO 0x00000001
50#define VERBOSE_MODES 0x00000002
51#define VERBOSE_RENDER 0x00000004
52#define VERBOSE_EVENT 0x00000008
53#define VERBOSE_AUDIO 0x00000010
54#define VERBOSE_MOTION 0x00000020
55
56/* !< Function pointer parsing one argument at argv[index], returning the number of parsed arguments,
57 * or a negative value when the argument is invalid */
58typedef int (SDLCALL *SDLTest_ParseArgumentsFp)(void *data, char **argv, int index);
59
60/* !< Finalize the argument parser. */
61typedef void (SDLCALL *SDLTest_FinalizeArgumentParserFp)(void *arg);
62
64{
65 /* !< Parse an argument. */
67 /* !< Finalize this argument parser. Called once before parsing the first argument. */
69 /* !< Null-terminated array of arguments. Printed when running with --help. */
70 const char **usage;
71 /* !< User data, passed to all callbacks. */
72 void *data;
73 /* !< Next argument parser. */
76
77typedef struct
78{
79 /* SDL init flags */
80 char **argv;
83
84 /* Video info */
85 const char *videodriver;
88 const char *window_title;
89 const char *window_icon;
106 float scale;
107 int depth;
114 const char *gpudriver;
115
116 /* Renderer info */
117 const char *renderdriver;
122
123 /* Audio info */
124 const char *audiodriver;
129
130 /* GL settings */
152
153 /* Mouse info */
156
157 /* Options info */
161
164
165#include <SDL3/SDL_begin_code.h>
166/* Set up for C function definitions, even when using C++ */
167#ifdef __cplusplus
168extern "C" {
169#endif
170
171/* Function prototypes */
172
173/**
174 * Parse command line parameters and create common state.
175 *
176 * \param argv Array of command line parameters
177 * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
178 *
179 * \returns a newly allocated common state object.
180 */
182
183/**
184 * Free the common state object.
185 *
186 * You should call SDL_Quit() before calling this function.
187 *
188 * \param state The common state object to destroy
189 */
191
192/**
193 * Process one common argument.
194 *
195 * \param state The common state describing the test window to create.
196 * \param index The index of the argument to process in argv[].
197 *
198 * \returns the number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
199 */
200int SDLCALL SDLTest_CommonArg(SDLTest_CommonState *state, int index);
201
202
203/**
204 * Logs command line usage info.
205 *
206 * This logs the appropriate command line options for the subsystems in use
207 * plus other common options, and then any application-specific options.
208 * This uses the SDL_Log() function and splits up output to be friendly to
209 * 80-character-wide terminals.
210 *
211 * \param state The common state describing the test window for the app.
212 * \param argv0 argv[0], as passed to main/SDL_main.
213 * \param options an array of strings for application specific options. The last element of the array should be NULL.
214 */
215void SDLCALL SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
216
217/**
218 * Open test window.
219 *
220 * \param state The common state describing the test window to create.
221 *
222 * \returns true if initialization succeeded, false otherwise
223 */
225
226/**
227 * Easy argument handling when test app doesn't need any custom args.
228 *
229 * \param state The common state describing the test window to create.
230 * \param argc argc, as supplied to SDL_main
231 * \param argv argv, as supplied to SDL_main
232 *
233 * \returns false if app should quit, true otherwise.
234 */
235bool SDLCALL SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, int argc, char **argv);
236
237/**
238 * Print the details of an event.
239 *
240 * This is automatically called by SDLTest_CommonEvent() as needed.
241 *
242 * \param event The event to print.
243 */
244void SDLCALL SDLTest_PrintEvent(const SDL_Event *event);
245
246/**
247 * Common event handler for test windows if you use a standard SDL_main.
248 *
249 * \param state The common state used to create test window.
250 * \param event The event to handle.
251 * \param done Flag indicating we are done.
252 */
253void SDLCALL SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done);
254
255/**
256 * Common event handler for test windows if you use SDL_AppEvent.
257 *
258 * This does _not_ free anything in `event`.
259 *
260 * \param state The common state used to create test window.
261 * \param event The event to handle.
262 * \returns Value suitable for returning from SDL_AppEvent().
263 */
265
266/**
267 * Close test window.
268 *
269 * \param state The common state used to create test window.
270 *
271 */
273
274/**
275 * Draws various window information (position, size, etc.) to the renderer.
276 *
277 * \param renderer The renderer to draw to.
278 * \param window The window whose information should be displayed.
279 * \param usedHeight Returns the height used, so the caller can draw more below.
280 *
281 */
282void SDLCALL SDLTest_CommonDrawWindowInfo(SDL_Renderer *renderer, SDL_Window *window, float *usedHeight);
283
284/* Ends C function definitions when using C++ */
285#ifdef __cplusplus
286}
287#endif
288#include <SDL3/SDL_close_code.h>
289
290#endif /* SDL_test_common_h_ */
Uint32 SDL_AudioDeviceID
Definition SDL_audio.h:280
SDL_AudioFormat
Definition SDL_audio.h:128
Uint32 SDL_InitFlags
Definition SDL_init.h:58
SDL_AppResult
Definition SDL_init.h:90
SDL_RendererLogicalPresentation
Definition SDL_render.h:106
struct SDL_Renderer SDL_Renderer
Definition SDL_render.h:119
uint32_t Uint32
Definition SDL_stdinc.h:356
void SDLTest_PrintEvent(const SDL_Event *event)
bool SDLTest_CommonInit(SDLTest_CommonState *state)
void SDLTest_CommonQuit(SDLTest_CommonState *state)
Uint32 SDLTest_VerboseFlags
bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, int argc, char **argv)
void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done)
int SDLTest_CommonArg(SDLTest_CommonState *state, int index)
void SDLTest_CommonDrawWindowInfo(SDL_Renderer *renderer, SDL_Window *window, float *usedHeight)
void(* SDLTest_FinalizeArgumentParserFp)(void *arg)
void SDLTest_CommonDestroyState(SDLTest_CommonState *state)
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options)
SDL_AppResult SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event *event)
int(* SDLTest_ParseArgumentsFp)(void *data, char **argv, int index)
SDLTest_CommonState * SDLTest_CommonCreateState(char **argv, SDL_InitFlags flags)
Uint32 SDL_DisplayID
Definition SDL_video.h:54
struct SDL_Window SDL_Window
Definition SDL_video.h:144
Uint64 SDL_WindowFlags
Definition SDL_video.h:158
SDLTest_FinalizeArgumentParserFp finalize
SDLTest_ParseArgumentsFp parse_arguments
struct SDLTest_ArgumentParser * next
SDLTest_ArgumentParser video_argparser
SDLTest_ArgumentParser common_argparser
SDL_Texture ** targets
SDLTest_ArgumentParser audio_argparser
const char * window_title
SDLTest_VerboseFlags verbose
SDL_DisplayID displayID
const char * videodriver
SDL_AudioDeviceID audio_id
const char * window_icon
SDL_AudioFormat audio_format
SDL_RendererLogicalPresentation logical_presentation
const char * renderdriver
SDL_WindowFlags window_flags
SDL_Renderer ** renderers
SDLTest_ArgumentParser * argparser
SDL_DisplayMode fullscreen_mode