summaryrefslogtreecommitdiff
path: root/macosx/plugins/DFInput/SDL/include/SDL.h
diff options
context:
space:
mode:
authorSND\weimingzhi_cp <SND\weimingzhi_cp@e17a0e51-4ae3-4d35-97c3-1a29b211df97>2010-07-31 12:31:11 +0000
committerSND\weimingzhi_cp <SND\weimingzhi_cp@e17a0e51-4ae3-4d35-97c3-1a29b211df97>2010-07-31 12:31:11 +0000
commit8bca7a2d9797c2b0546895f5e62fc05b38183468 (patch)
tree19e6bad8d1c3eabaaa7e34fe425a702ef7eb1e2b /macosx/plugins/DFInput/SDL/include/SDL.h
parentdd4c0b039bcd38459cd5545d087c2b047198067b (diff)
downloadpcsxr-8bca7a2d9797c2b0546895f5e62fc05b38183468.tar.gz
dfinput (macosx): upgraded to SDL 1.3 Beta.
git-svn-id: https://pcsxr.svn.codeplex.com/svn/pcsxr@55318 e17a0e51-4ae3-4d35-97c3-1a29b211df97
Diffstat (limited to 'macosx/plugins/DFInput/SDL/include/SDL.h')
-rw-r--r--macosx/plugins/DFInput/SDL/include/SDL.h124
1 files changed, 93 insertions, 31 deletions
diff --git a/macosx/plugins/DFInput/SDL/include/SDL.h b/macosx/plugins/DFInput/SDL/include/SDL.h
index f909fa1f..6032d95c 100644
--- a/macosx/plugins/DFInput/SDL/include/SDL.h
+++ b/macosx/plugins/DFInput/SDL/include/SDL.h
@@ -1,6 +1,6 @@
/*
SDL - Simple DirectMedia Layer
- Copyright (C) 1997-2006 Sam Lantinga
+ Copyright (C) 1997-2010 Sam Lantinga
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
@@ -19,70 +19,132 @@
Sam Lantinga
slouken@libsdl.org
*/
+// 7/31/2010 Wei Mingzhi
+// Removed everything unrated to Mac OS X Joystick support
-// 7-25-2010 Wei Mingzhi
-// Removed everything unrelated to Mac OS X Joystick support.
+/**
+ * \file SDL.h
+ *
+ * Main include header for the SDL library
+ */
-/* Main include header for the SDL library */
+/**
+ * \mainpage Simple DirectMedia Layer (SDL)
+ *
+ * http://www.libsdl.org/
+ *
+ * \section intro_sec Introduction
+ *
+ * This is the Simple DirectMedia Layer, a general API that provides low
+ * level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
+ * and 2D framebuffer across multiple platforms.
+ *
+ * The current version supports Windows, Windows CE, Mac OS X, Linux,
+ * FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, and QNX. The code contains
+ * support for other operating systems but those are not officially supported.
+ *
+ * SDL is written in C, but works with C++ natively, and has bindings to
+ * several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
+ * Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
+ * Pike, Pliant, Python, Ruby, and Smalltalk.
+ *
+ * This library is distributed under GNU LGPL version 2, which can be
+ * found in the file "COPYING". This license allows you to use SDL
+ * freely in commercial programs as long as you link with the dynamic
+ * library.
+ *
+ * The best way to learn how to use SDL is to check out the header files in
+ * the "include" subdirectory and the programs in the "test" subdirectory.
+ * The header files and test programs are well commented and always up to date.
+ * More documentation is available in HTML format in "docs/index.html", and
+ * a documentation wiki is available online at:
+ * http://www.libsdl.org/cgi/docwiki.cgi
+ *
+ * The test programs in the "test" subdirectory are in the public domain.
+ *
+ * Frequently asked questions are answered online:
+ * http://www.libsdl.org/faq.php
+ *
+ * If you need help with the library, or just want to discuss SDL related
+ * issues, you can join the developers mailing list:
+ * http://www.libsdl.org/mailing-list.php
+ *
+ * Enjoy!
+ * Sam Lantinga (slouken@libsdl.org)
+ */
#ifndef _SDL_H
#define _SDL_H
+#include "SDL_main.h"
#include "SDL_stdinc.h"
#include "SDL_endian.h"
#include "SDL_error.h"
-#include "SDL_version.h"
-#include "SDL_joystick.h"
-#define SDL_IGNORE 0
+#ifndef SDL_IGNORE
+#define SDL_IGNORE 0
+#endif
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
+/* *INDENT-OFF* */
extern "C" {
+/* *INDENT-ON* */
#endif
/* As of version 0.5, SDL is loaded dynamically into the application */
-/* These are the flags which may be passed to SDL_Init() -- you should
- specify the subsystems which you will be using in your application.
-*/
-#define SDL_INIT_TIMER 0x00000001
-#define SDL_INIT_AUDIO 0x00000010
-#define SDL_INIT_VIDEO 0x00000020
-#define SDL_INIT_CDROM 0x00000100
-#define SDL_INIT_JOYSTICK 0x00000200
-#define SDL_INIT_NOPARACHUTE 0x00100000 /* Don't catch fatal signals */
-#define SDL_INIT_EVENTTHREAD 0x01000000 /* Not supported on all OS's */
-#define SDL_INIT_EVERYTHING 0x0000FFFF
-
-/* This function loads the SDL dynamically linked library and initializes
- * the subsystems specified by 'flags' (and those satisfying dependencies)
- * Unless the SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
- * signal handlers for some commonly ignored fatal signals (like SIGSEGV)
+/**
+ * \name SDL_INIT_*
+ *
+ * These are the flags which may be passed to SDL_Init(). You should
+ * specify the subsystems which you will be using in your application.
+ */
+/*@{*/
+#define SDL_INIT_JOYSTICK 0x00000200
+#define SDL_INIT_HAPTIC 0x00001000
+#define SDL_INIT_NOPARACHUTE 0x00100000 /**< Don't catch fatal signals */
+#define SDL_INIT_EVERYTHING 0x0000FFFF
+/*@}*/
+
+/**
+ * This function loads the SDL dynamically linked library and initializes
+ * the subsystems specified by \c flags (and those satisfying dependencies).
+ * Unless the ::SDL_INIT_NOPARACHUTE flag is set, it will install cleanup
+ * signal handlers for some commonly ignored fatal signals (like SIGSEGV).
*/
extern DECLSPEC int SDLCALL SDL_Init(Uint32 flags);
-/* This function initializes specific SDL subsystems */
+/**
+ * This function initializes specific SDL subsystems
+ */
extern DECLSPEC int SDLCALL SDL_InitSubSystem(Uint32 flags);
-/* This function cleans up specific SDL subsystems */
+/**
+ * This function cleans up specific SDL subsystems
+ */
extern DECLSPEC void SDLCALL SDL_QuitSubSystem(Uint32 flags);
-/* This function returns mask of the specified subsystems which have
- been initialized.
- If 'flags' is 0, it returns a mask of all initialized subsystems.
-*/
+/**
+ * This function returns mask of the specified subsystems which have
+ * been initialized.
+ *
+ * If \c flags is 0, it returns a mask of all initialized subsystems.
+ */
extern DECLSPEC Uint32 SDLCALL SDL_WasInit(Uint32 flags);
-/* This function cleans up all initialized subsystems and unloads the
- * dynamically linked library. You should call it upon all exit conditions.
+/**
+ * This function cleans up all initialized subsystems and unloads the
+ * dynamically linked library. You should call it upon all exit conditions.
*/
extern DECLSPEC void SDLCALL SDL_Quit(void);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
+/* *INDENT-OFF* */
}
+/* *INDENT-ON* */
#endif
#include "close_code.h"