include/SDL_test_common.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 15 Feb 2013 08:47:44 -0800
changeset 6885 700f1b25f77f
parent 6788 036f53f2f5aa
child 7009 161b7b6a5303
permissions -rw-r--r--
Happy New Year!
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 SDL2_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 "SDL.h"
    36 
    37 #ifdef __NDS__
    38 #define DEFAULT_WINDOW_WIDTH  256
    39 #define DEFAULT_WINDOW_HEIGHT (2*192)
    40 #else
    41 #define DEFAULT_WINDOW_WIDTH  640
    42 #define DEFAULT_WINDOW_HEIGHT 480
    43 #endif
    44 
    45 #define VERBOSE_VIDEO   0x00000001
    46 #define VERBOSE_MODES   0x00000002
    47 #define VERBOSE_RENDER  0x00000004
    48 #define VERBOSE_EVENT   0x00000008
    49 #define VERBOSE_AUDIO   0x00000010
    50 
    51 typedef struct
    52 {
    53     /* SDL init flags */
    54     char **argv;
    55     Uint32 flags;
    56     Uint32 verbose;
    57 
    58     /* Video info */
    59     const char *videodriver;
    60     int display;
    61     const char *window_title;
    62     const char *window_icon;
    63     Uint32 window_flags;
    64     int window_x;
    65     int window_y;
    66     int window_w;
    67     int window_h;
    68     int window_minW;
    69     int window_minH;
    70     int window_maxW;
    71     int window_maxH;
    72     int depth;
    73     int refresh_rate;
    74     int num_windows;
    75     SDL_Window **windows;
    76 
    77     /* Renderer info */
    78     const char *renderdriver;
    79     Uint32 render_flags;
    80     SDL_bool skip_renderer;
    81     SDL_Renderer **renderers;
    82 
    83     /* Audio info */
    84     const char *audiodriver;
    85     SDL_AudioSpec audiospec;
    86 
    87     /* GL settings */
    88     int gl_red_size;
    89     int gl_green_size;
    90     int gl_blue_size;
    91     int gl_alpha_size;
    92     int gl_buffer_size;
    93     int gl_depth_size;
    94     int gl_stencil_size;
    95     int gl_double_buffer;
    96     int gl_accum_red_size;
    97     int gl_accum_green_size;
    98     int gl_accum_blue_size;
    99     int gl_accum_alpha_size;
   100     int gl_stereo;
   101     int gl_multisamplebuffers;
   102     int gl_multisamplesamples;
   103     int gl_retained_backing;
   104     int gl_accelerated;
   105     int gl_major_version;
   106     int gl_minor_version;
   107 } SDLTest_CommonState;
   108 
   109 #include "begin_code.h"
   110 /* Set up for C function definitions, even when using C++ */
   111 #ifdef __cplusplus
   112 /* *INDENT-OFF* */
   113 extern "C" {
   114 /* *INDENT-ON* */
   115 #endif
   116 
   117 /* Function prototypes */
   118 
   119 /**
   120  * \brief Parse command line parameters and create common state.
   121  *
   122  * \param argv Array of command line parameters
   123  * \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
   124  *
   125  * \returns Returns a newly allocated common state object.
   126  */
   127 SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
   128 
   129 /**
   130  * \brief Process one common argument.
   131  *
   132  * \param state The common state describing the test window to create.
   133  * \param index The index of the argument to process in argv[].
   134  *
   135  * \returns The number of arguments processed (i.e. 1 for --fullscreen, 2 for --video [videodriver], or -1 on error.
   136  */
   137 int SDLTest_CommonArg(SDLTest_CommonState * state, int index);
   138 
   139 /**
   140  * \brief Returns common usage information
   141  *
   142  * \param state The common state describing the test window to create.
   143  *
   144  * \returns String with usage information
   145  */
   146 const char *SDLTest_CommonUsage(SDLTest_CommonState * state);
   147 
   148 /**
   149  * \brief Open test window.
   150  *
   151  * \param state The common state describing the test window to create.
   152  *
   153  * \returns True if initialization succeeded, false otherwise
   154  */
   155 SDL_bool SDLTest_CommonInit(SDLTest_CommonState * state);
   156 
   157 /**
   158  * \brief Common event handler for test windows.
   159  *
   160  * \param state The common state used to create test window.
   161  * \param event The event to handle.
   162  * \param done Flag indicating we are done.
   163  *
   164  */
   165 void SDLTest_CommonEvent(SDLTest_CommonState * state, SDL_Event * event, int *done);
   166 
   167 /**
   168  * \brief Close test window.
   169  *
   170  * \param state The common state used to create test window.
   171  *
   172  */
   173 void SDLTest_CommonQuit(SDLTest_CommonState * state);
   174 
   175 
   176 /* Ends C function definitions when using C++ */
   177 #ifdef __cplusplus
   178 /* *INDENT-OFF* */
   179 }
   180 /* *INDENT-ON* */
   181 #endif
   182 #include "close_code.h"
   183 
   184 #endif /* _SDL_test_common_h */
   185 
   186 /* vi: set ts=4 sw=4 expandtab: */