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
56typedef struct
57{
58 /* SDL init flags */
59 char **argv;
62
63 /* Video info */
64 const char *videodriver;
67 const char *window_title;
68 const char *window_icon;
86 float scale;
87 int depth;
94
95 /* Renderer info */
96 const char *renderdriver;
101
102 /* Audio info */
103 const char *audiodriver;
108
109 /* GL settings */
131
132 /* Mouse info */
135
137
138#include <SDL3/SDL_begin_code.h>
139/* Set up for C function definitions, even when using C++ */
140#ifdef __cplusplus
141extern "C" {
142#endif
143
144/* Function prototypes */
145
146/**
147 * Parse command line parameters and create common state.
148 *
149 * \param argv Array of command line parameters
150 * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
151 *
152 * \returns a newly allocated common state object.
153 */
155
156/**
157 * Free the common state object.
158 *
159 * You should call SDL_Quit() before calling this function.
160 *
161 * \param state The common state object to destroy
162 */
164
165/**
166 * Process one common argument.
167 *
168 * \param state The common state describing the test window to create.
169 * \param index The index of the argument to process in argv[].
170 *
171 * \returns the number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
172 */
174
175
176/**
177 * Logs command line usage info.
178 *
179 * This logs the appropriate command line options for the subsystems in use
180 * plus other common options, and then any application-specific options.
181 * This uses the SDL_Log() function and splits up output to be friendly to
182 * 80-character-wide terminals.
183 *
184 * \param state The common state describing the test window for the app.
185 * \param argv0 argv[0], as passed to main/SDL_main.
186 * \param options an array of strings for application specific options. The last element of the array should be NULL.
187 */
188void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
189
190/**
191 * Open test window.
192 *
193 * \param state The common state describing the test window to create.
194 *
195 * \returns SDL_TRUE if initialization succeeded, false otherwise
196 */
198
199/**
200 * Easy argument handling when test app doesn't need any custom args.
201 *
202 * \param state The common state describing the test window to create.
203 * \param argc argc, as supplied to SDL_main
204 * \param argv argv, as supplied to SDL_main
205 *
206 * \returns SDL_FALSE if app should quit, true otherwise.
207 */
208SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, const int argc, char **argv);
209
210/**
211 * Common event handler for test windows if you use a standard SDL_main.
212 *
213 * This will free data from the event, like the string in a drop event!
214 *
215 * \param state The common state used to create test window.
216 * \param event The event to handle.
217 * \param done Flag indicating we are done.
218 */
219void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done);
220
221/**
222 * Common event handler for test windows if you use SDL_AppEvent.
223 *
224 * This does _not_ free anything in `event`.
225 *
226 * \param state The common state used to create test window.
227 * \param event The event to handle.
228 * \returns Value suitable for returning from SDL_AppEvent().
229 */
231
232/**
233 * Close test window.
234 *
235 * \param state The common state used to create test window.
236 *
237 */
239
240/**
241 * Draws various window information (position, size, etc.) to the renderer.
242 *
243 * \param renderer The renderer to draw to.
244 * \param window The window whose information should be displayed.
245 * \param usedHeight Returns the height used, so the caller can draw more below.
246 *
247 */
248void SDLTest_CommonDrawWindowInfo(SDL_Renderer *renderer, SDL_Window *window, float *usedHeight);
249
250/* Ends C function definitions when using C++ */
251#ifdef __cplusplus
252}
253#endif
254#include <SDL3/SDL_close_code.h>
255
256#endif /* SDL_test_common_h_ */
Uint32 SDL_AudioDeviceID
Definition SDL_audio.h:279
SDL_AudioFormat
Definition SDL_audio.h:129
Uint32 SDL_InitFlags
Definition SDL_init.h:57
struct SDL_Texture SDL_Texture
Definition SDL_render.h:123
SDL_RendererLogicalPresentation
Definition SDL_render.h:103
struct SDL_Renderer SDL_Renderer
Definition SDL_render.h:116
int SDL_bool
Definition SDL_stdinc.h:213
uint32_t Uint32
Definition SDL_stdinc.h:265
SDL_ScaleMode
Definition SDL_surface.h:72
void SDLTest_CommonQuit(SDLTest_CommonState *state)
SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, const int argc, char **argv)
Uint32 SDLTest_VerboseFlags
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)
SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state)
void SDLTest_CommonDestroyState(SDLTest_CommonState *state)
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options)
int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event *event)
SDLTest_CommonState * SDLTest_CommonCreateState(char **argv, SDL_InitFlags flags)
Uint32 SDL_DisplayID
Definition SDL_video.h:45
struct SDL_Window SDL_Window
Definition SDL_video.h:127
Uint64 SDL_WindowFlags
Definition SDL_video.h:141
SDL_Window ** windows
SDL_Texture ** targets
SDL_ScaleMode logical_scale_mode
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
SDL_DisplayMode fullscreen_mode