author Philipp Wiesemann <>
Sun, 18 Aug 2013 11:08:52 +0200
changeset 7653 9a0e274b8aa7
parent 7335 13b67be8e3af
child 8028 e3e00f8e6b91
child 8535 e8ee0708ef5c
permissions -rw-r--r--
Changed some documentation comments in header files to be used by doxygen.

  Simple DirectMedia Layer
  Copyright (C) 1997-2013 Sam Lantinga <>

  This software is provided 'as-is', without any express or implied
  warranty.  In no event will the authors be held liable for any damages
  arising from the use of this software.

  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not
     claim that you wrote the original software. If you use this software
     in a product, an acknowledgment in the product documentation would be
     appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be
     misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.

#ifndef _SDL_main_h
#define _SDL_main_h

#include "SDL_stdinc.h"

 *  \file SDL_main.h
 *  Redefine main() on some platforms so that it is called by SDL.

#if defined(__WIN32__)
/* On Windows SDL provides WinMain(), which parses the command line and passes
   the arguments to your main function.

   If you provide your own WinMain(), you may define SDL_MAIN_HANDLED

#elif defined(__IPHONEOS__)
/* On iOS SDL provides a main function that creates an application delegate
   and starts the iOS application run loop.

   See src/video/uikit/SDL_uikitappdelegate.m for more details.

#elif defined(__ANDROID__)
/* On Android SDL provides a Java class in that is the
   main activity entry point.

   See README-android.txt for more details on extending that class.

#endif /* SDL_MAIN_HANDLED */

#ifdef __cplusplus
#define C_LINKAGE   "C"
#define C_LINKAGE
#endif /* __cplusplus */

 *  \file SDL_main.h
 *  The application's main() function must be called with C linkage,
 *  and should be declared like this:
 *  \code
 *  #ifdef __cplusplus
 *  extern "C"
 *  #endif
 *  int main(int argc, char *argv[])
 *  {
 *  }
 *  \endcode

#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE)
#define main    SDL_main

 *  The prototype for the application's main() function
extern C_LINKAGE int SDL_main(int argc, char *argv[]);

#include "begin_code.h"
#ifdef __cplusplus
extern "C" {

 *  This is called by the real SDL main function to let the rest of the
 *  library know that initialization was done properly.
 *  Calling this yourself without knowing what you're doing can cause
 *  crashes and hard to diagnose problems with your application.
extern DECLSPEC void SDL_SetMainReady(void);

#ifdef __WIN32__

 *  This can be called to set the application class at startup
extern DECLSPEC int SDLCALL SDL_RegisterApp(char *name, Uint32 style,
                                            void *hInst);
extern DECLSPEC void SDLCALL SDL_UnregisterApp(void);

#endif /* __WIN32__ */

#ifdef __cplusplus
#include "close_code.h"

#endif /* _SDL_main_h */

/* vi: set ts=4 sw=4 expandtab: */