SDL 3.0
SDL_test_common.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 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 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#if defined(__PSP__)
38#define DEFAULT_WINDOW_WIDTH 480
39#define DEFAULT_WINDOW_HEIGHT 272
40#elif defined(__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
48#define VERBOSE_VIDEO 0x00000001
49#define VERBOSE_MODES 0x00000002
50#define VERBOSE_RENDER 0x00000004
51#define VERBOSE_EVENT 0x00000008
52#define VERBOSE_AUDIO 0x00000010
53#define VERBOSE_MOTION 0x00000020
54
55typedef struct
56{
57 /* SDL init flags */
58 char **argv;
61
62 /* Video info */
63 const char *videodriver;
66 const char *window_title;
67 const char *window_icon;
82 float scale;
83 int depth;
89
90 /* Renderer info */
91 const char *renderdriver;
96
97 /* Audio info */
98 const char *audiodriver;
101
102 /* GL settings */
124
125 /* Additional fields added in 2.0.18 */
127
129
130#include <SDL3/SDL_begin_code.h>
131/* Set up for C function definitions, even when using C++ */
132#ifdef __cplusplus
133extern "C" {
134#endif
135
136/* Function prototypes */
137
138/**
139 * \brief Parse command line parameters and create common state.
140 *
141 * \param argv Array of command line parameters
142 * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
143 *
144 * \returns a newly allocated common state object.
145 */
147
148/**
149 * \brief Process one common argument.
150 *
151 * \param state The common state describing the test window to create.
152 * \param index The index of the argument to process in argv[].
153 *
154 * \returns the number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
155 */
157
158
159/**
160 * \brief Logs command line usage info.
161 *
162 * This logs the appropriate command line options for the subsystems in use
163 * plus other common options, and then any application-specific options.
164 * This uses the SDL_Log() function and splits up output to be friendly to
165 * 80-character-wide terminals.
166 *
167 * \param state The common state describing the test window for the app.
168 * \param argv0 argv[0], as passed to main/SDL_main.
169 * \param options an array of strings for application specific options. The last element of the array should be NULL.
170 */
171void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
172
173/**
174 * \brief Returns common usage information
175 *
176 * You should (probably) be using SDLTest_CommonLogUsage() instead, but this
177 * function remains for binary compatibility. Strings returned from this
178 * function are valid until SDLTest_CommonQuit() is called, in which case
179 * those strings' memory is freed and can no longer be used.
180 *
181 * \param state The common state describing the test window to create.
182 * \returns a string with usage information
183 */
185
186/**
187 * \brief Open test window.
188 *
189 * \param state The common state describing the test window to create.
190 *
191 * \returns SDL_TRUE if initialization succeeded, false otherwise
192 */
194
195/**
196 * \brief Easy argument handling when test app doesn't need any custom args.
197 *
198 * \param state The common state describing the test window to create.
199 * \param argc argc, as supplied to SDL_main
200 * \param argv argv, as supplied to SDL_main
201 *
202 * \returns SDL_FALSE if app should quit, true otherwise.
203 */
204SDL_bool SDLTest_CommonDefaultArgs(SDLTest_CommonState *state, const int argc, char **argv);
205
206/**
207 * \brief Common event handler for test windows.
208 *
209 * \param state The common state used to create test window.
210 * \param event The event to handle.
211 * \param done Flag indicating we are done.
212 *
213 */
215
216/**
217 * \brief Close test window.
218 *
219 * \param state The common state used to create test window.
220 *
221 */
223
224/**
225 * \brief Draws various window information (position, size, etc.) to the renderer.
226 *
227 * \param renderer The renderer to draw to.
228 * \param window The window whose information should be displayed.
229 * \param usedHeight Returns the height used, so the caller can draw more below.
230 *
231 */
232void SDLTest_CommonDrawWindowInfo(SDL_Renderer *renderer, SDL_Window *window, float *usedHeight);
233
234/* Ends C function definitions when using C++ */
235#ifdef __cplusplus
236}
237#endif
238#include <SDL3/SDL_close_code.h>
239
240#endif /* SDL_test_common_h_ */
Uint32 SDL_AudioDeviceID
Definition: SDL_audio.h:267
struct _cl_event * event
GLuint index
GLbitfield flags
struct SDL_Texture SDL_Texture
Definition: SDL_render.h:160
SDL_ScaleMode
Definition: SDL_render.h:101
SDL_RendererLogicalPresentation
Definition: SDL_render.h:141
struct SDL_Renderer SDL_Renderer
Definition: SDL_render.h:154
SDL_bool
Definition: SDL_stdinc.h:130
uint32_t Uint32
Definition: SDL_stdinc.h:171
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.
void SDLTest_CommonDrawWindowInfo(SDL_Renderer *renderer, SDL_Window *window, float *usedHeight)
Draws various window information (position, size, etc.) to the renderer.
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.
const char * SDLTest_CommonUsage(SDLTest_CommonState *state)
Returns common usage information.
Uint32 SDL_DisplayID
Definition: SDL_video.h:43
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:101
The structure that defines a display mode.
Definition: SDL_video.h:56
SDL_Window ** windows
SDL_bool fullscreen_exclusive
SDL_AudioSpec audiospec
SDL_Texture ** targets
SDL_ScaleMode logical_scale_mode
const char * window_title
SDL_bool flash_on_focus_loss
SDL_DisplayID displayID
const char * videodriver
SDL_AudioDeviceID audio_id
const char * window_icon
SDL_RendererLogicalPresentation logical_presentation
const char * renderdriver
const char * audiodriver
SDL_Renderer ** renderers
SDL_DisplayMode fullscreen_mode
General event structure.
Definition: SDL_events.h:588