SDL_test_common.h File Reference

#include "SDL.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Classes
struct	SDLTest_CommonState

Macros
#define	DEFAULT_WINDOW_WIDTH   640
#define	DEFAULT_WINDOW_HEIGHT   480
#define	VERBOSE_VIDEO   0x00000001
#define	VERBOSE_MODES   0x00000002
#define	VERBOSE_RENDER   0x00000004
#define	VERBOSE_EVENT   0x00000008
#define	VERBOSE_AUDIO   0x00000010

Functions
SDLTest_CommonState *	SDLTest_CommonCreateState (char **argv, Uint32 flags)
	Parse command line parameters and create common state. More...
int	SDLTest_CommonArg (SDLTest_CommonState *state, int index)
	Process one common argument. More...
void	SDLTest_CommonLogUsage (SDLTest_CommonState *state, const char *argv0, const char **options)
	Logs command line usage info. More...
SDL_bool	SDLTest_CommonInit (SDLTest_CommonState *state)
	Open test window. More...
SDL_bool	SDLTest_CommonDefaultArgs (SDLTest_CommonState *state, const int argc, char **argv)
	Easy argument handling when test app doesn't need any custom args. More...
void	SDLTest_CommonEvent (SDLTest_CommonState *state, SDL_Event *event, int *done)
	Common event handler for test windows. More...
void	SDLTest_CommonQuit (SDLTest_CommonState *state)
	Close test window. More...

Detailed Description

Include file for SDL test framework.

This code is a part of the SDL2_test library, not the main SDL library.

Definition in file SDL_test_common.h.

Macro Definition Documentation

DEFAULT_WINDOW_HEIGHT

#define DEFAULT_WINDOW_HEIGHT   480

Definition at line 42 of file SDL_test_common.h.

DEFAULT_WINDOW_WIDTH

#define DEFAULT_WINDOW_WIDTH   640

Definition at line 41 of file SDL_test_common.h.

VERBOSE_AUDIO

#define VERBOSE_AUDIO   0x00000010

Definition at line 49 of file SDL_test_common.h.

VERBOSE_EVENT

#define VERBOSE_EVENT   0x00000008

Definition at line 48 of file SDL_test_common.h.

VERBOSE_MODES

#define VERBOSE_MODES   0x00000002

Definition at line 46 of file SDL_test_common.h.

VERBOSE_RENDER

#define VERBOSE_RENDER   0x00000004

Definition at line 47 of file SDL_test_common.h.

VERBOSE_VIDEO

#define VERBOSE_VIDEO   0x00000001

Definition at line 45 of file SDL_test_common.h.

Function Documentation

SDLTest_CommonArg()

int SDLTest_CommonArg	(	SDLTest_CommonState *	state,
		int	index
	)

Process one common argument.

Parameters

state	The common state describing the test window to create.
index	The index of the argument to process in argv[].

Returns

The number of arguments processed (i.e. 1 for –fullscreen, 2 for –video [videodriver], or -1 on error.

SDLTest_CommonCreateState()

SDLTest_CommonState* SDLTest_CommonCreateState	(	char **	argv,
		Uint32	flags
	)

Parse command line parameters and create common state.

Parameters

argv	Array of command line parameters
flags	Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)

Returns

Returns a newly allocated common state object.

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.

Parameters

state	The common state describing the test window to create.
argc	argc, as supplied to SDL_main
argv	argv, as supplied to SDL_main

Returns

False if app should quit, true otherwise.

SDLTest_CommonEvent()

void SDLTest_CommonEvent	(	SDLTest_CommonState *	state,
		SDL_Event *	event,
		int *	done
	)

Common event handler for test windows.

Parameters

state	The common state used to create test window.
event	The event to handle.
done	Flag indicating we are done.

SDLTest_CommonInit()

SDL_bool SDLTest_CommonInit

(

SDLTest_CommonState *

state

)

Open test window.

Parameters

state

The common state describing the test window to create.

Returns

True if initialization succeeded, false otherwise

SDLTest_CommonLogUsage()

void SDLTest_CommonLogUsage	(	SDLTest_CommonState *	state,
		const char *	argv0,
		const char **	options
	)

Logs command line usage info.

This logs the appropriate command line options for the subsystems in use plus other common options, and then any application-specific options. This uses the SDL_Log() function and splits up output to be friendly to 80-character-wide terminals.

Parameters

state	The common state describing the test window for the app.
argv0	argv[0], as passed to main/SDL_main.
options	an array of strings for application specific options. The last element of the array should be NULL.

SDLTest_CommonQuit()

void SDLTest_CommonQuit

(

SDLTest_CommonState *

state

)

Close test window.

Parameters

state

The common state used to create test window.