Miguel Ruiz / SDL_lib

SDL standard library

Dependents:   H261_encoder

Embed: (wiki syntax)

« Back to documentation index

SDL_test_common.h File Reference
Functions

SDL_test_common.h File Reference

Include file for SDL test framework. More...

Go to the source code of this file.

Functions

SDLTest_CommonState * SDLTest_CommonCreateState (char **argv, Uint32 flags)
 Parse command line parameters and create common state.
int SDLTest_CommonArg (SDLTest_CommonState *state, int index)
 Process one common argument.
const char * SDLTest_CommonUsage (SDLTest_CommonState *state)
 Returns common usage information.
SDL_bool SDLTest_CommonInit (SDLTest_CommonState *state)
 Open test window.
void SDLTest_CommonEvent (SDLTest_CommonState *state, SDL_Event *event, int *done)
 Common event handler for test windows.
void SDLTest_CommonQuit (SDLTest_CommonState *state)
 Close test window.

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.

Function Documentation

int SDLTest_CommonArg ( SDLTest_CommonState *  state,
int  index 
)

Process one common argument.

Parameters:
stateThe common state describing the test window to create.
indexThe 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_CommonState* SDLTest_CommonCreateState ( char **  argv,
Uint32  flags 
)

Parse command line parameters and create common state.

Parameters:
argvArray of command line parameters
flagsFlags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
Returns:
Returns a newly allocated common state object.
void SDLTest_CommonEvent ( SDLTest_CommonState *  state,
SDL_Event *  event,
int *  done 
)

Common event handler for test windows.

Parameters:
stateThe common state used to create test window.
eventThe event to handle.
doneFlag indicating we are done.
SDL_bool SDLTest_CommonInit ( SDLTest_CommonState *  state )

Open test window.

Parameters:
stateThe common state describing the test window to create.
Returns:
True if initialization succeeded, false otherwise
void SDLTest_CommonQuit ( SDLTest_CommonState *  state )

Close test window.

Parameters:
stateThe common state used to create test window.
const char* SDLTest_CommonUsage ( SDLTest_CommonState *  state )

Returns common usage information.

Parameters:
stateThe common state describing the test window to create.
Returns:
String with usage information
Generated on Tue Jul 12 2022 13:56:25 by  doxygen 1.7.2