annotate include/SDL_types.h @ 1223:ba2d708ee116

Removed some incorrect comments in the "dc" driver that survived the initial cut-and-paste from the dummy video skeleton.
author Ryan C. Gordon <icculus@icculus.org>
date Wed, 04 Jan 2006 19:25:18 +0000
parents 173c063d4f55
children c9b51268668f
rev   line source
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
1 /*
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
2 SDL - Simple DirectMedia Layer
769
b8d311d90021 Updated copyright information for 2004 (Happy New Year!)
Sam Lantinga <slouken@libsdl.org>
parents: 661
diff changeset
3 Copyright (C) 1997-2004 Sam Lantinga
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
4
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
5 This library is free software; you can redistribute it and/or
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
6 modify it under the terms of the GNU Library General Public
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
7 License as published by the Free Software Foundation; either
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
8 version 2 of the License, or (at your option) any later version.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
9
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
13 Library General Public License for more details.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
14
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
15 You should have received a copy of the GNU Library General Public
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
16 License along with this library; if not, write to the Free
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
18
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
19 Sam Lantinga
251
b8688cfdc232 Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents: 173
diff changeset
20 slouken@libsdl.org
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
21 */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
22
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
23 #ifdef SAVE_RCSID
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
24 static char rcsid =
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
25 "@(#) $Id$";
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
26 #endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
27
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
28 /* General data types used by the SDL library */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
29
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
30 #ifndef _SDL_types_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
31 #define _SDL_types_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
32
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
33 /* The number of elements in a table */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
34 #define SDL_TABLESIZE(table) (sizeof(table)/sizeof(table[0]))
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
35
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
36 /* Basic data types */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
37 typedef enum {
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
38 SDL_FALSE = 0,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
39 SDL_TRUE = 1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
40 } SDL_bool;
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
41
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
42 #ifdef H_MMBASIC /* mmbasic.h (Tru64 MME) */
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
43 /* Some of the basic types are already defined in mmbasic.h */
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
44 typedef signed char Sint8;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
45 typedef signed short Sint16;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
46 typedef signed int Sint32;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
47 #else
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
48 typedef unsigned char Uint8;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
49 typedef signed char Sint8;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
50 typedef unsigned short Uint16;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
51 typedef signed short Sint16;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
52 typedef unsigned int Uint32;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
53 typedef signed int Sint32;
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
54 #endif
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
55
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
56 /* Figure out how to support 64-bit datatypes */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
57 #if !defined(__STRICT_ANSI__)
912
bc0b95b02235 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 908
diff changeset
58 #ifdef __osf__ /* Tru64 */
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
59 #define SDL_HAS_64BIT_TYPE long
1190
173c063d4f55 OS/2 port!
Ryan C. Gordon <icculus@icculus.org>
parents: 912
diff changeset
60 #elif defined(__GNUC__) || defined(__MWERKS__) || defined(__SUNPRO_C) || defined(__DECC) || defined(__WATCOMC__)
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
61 #define SDL_HAS_64BIT_TYPE long long
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
62 #elif defined(_MSC_VER) /* VC++ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
63 #define SDL_HAS_64BIT_TYPE __int64
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
64 #endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
65 #endif /* !__STRICT_ANSI__ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
66
173
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
67 /* The 64-bit type isn't available on EPOC/Symbian OS */
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
68 #ifdef __SYMBIAN32__
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
69 #undef SDL_HAS_64BIT_TYPE
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
70 #endif
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
71
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
72 /* The 64-bit datatype isn't supported on all platforms */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
73 #ifdef SDL_HAS_64BIT_TYPE
654
e92bcf2573cb Added audio and CD-ROM support for OSF/Tru64 (thanks Hayashi!)
Sam Lantinga <slouken@libsdl.org>
parents: 534
diff changeset
74 #ifndef H_MMBASIC
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
75 typedef unsigned SDL_HAS_64BIT_TYPE Uint64;
654
e92bcf2573cb Added audio and CD-ROM support for OSF/Tru64 (thanks Hayashi!)
Sam Lantinga <slouken@libsdl.org>
parents: 534
diff changeset
76 #endif
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
77 typedef SDL_HAS_64BIT_TYPE Sint64;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
78 #else
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
79 /* This is really just a hack to prevent the compiler from complaining */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
80 typedef struct {
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
81 Uint32 hi;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
82 Uint32 lo;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
83 } Uint64, Sint64;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
84 #endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
85
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
86 /* Make sure the types really have the right sizes */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
87 #define SDL_COMPILE_TIME_ASSERT(name, x) \
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
88 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
89
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
90 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
91 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
92 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
93 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
94 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
95 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
96 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
97 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
98
463
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
99 /* Check to make sure enums are the size of ints, for structure packing.
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
100 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
101 enums having the size of an int must be enabled.
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
102 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
103 */
534
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
104 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
105 #ifdef __MWERKS__
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
106 #pragma enumsalwaysint on
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
107 #endif
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
108
463
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
109 typedef enum {
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
110 DUMMY_ENUM_VALUE
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
111 } SDL_DUMMY_ENUM;
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
112
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
113 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
114
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
115 #undef SDL_COMPILE_TIME_ASSERT
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
116
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
117 /* General keyboard/mouse state definitions */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
118 enum { SDL_PRESSED = 0x01, SDL_RELEASED = 0x00 };
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
119
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
120 #endif