include/SDL_types.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 1190 173c063d4f55
child 1330 450721ad5436
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges) I batch edited these files, so please let me know if I've accidentally removed anybody's credit here.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
     3
    Copyright (C) 1997-2006 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
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
     6
    modify it under the terms of the GNU Lesser General Public
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
     7
    License as published by the Free Software Foundation; either
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
     8
    version 2.1 of the License, or (at your option) any later version.
0
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
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
    13
    Lesser General Public License for more details.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    14
1312
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
    15
    You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
    16
    License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents: 1190
diff changeset
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
0
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
/* General data types used by the SDL library */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    24
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    25
#ifndef _SDL_types_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    26
#define _SDL_types_h
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    27
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    28
/* The number of elements in a table */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    29
#define SDL_TABLESIZE(table)	(sizeof(table)/sizeof(table[0]))
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    30
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    31
/* Basic data types */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    32
typedef enum {
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    33
	SDL_FALSE = 0,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    34
	SDL_TRUE  = 1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    35
} SDL_bool;
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    36
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    37
#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
    38
/* 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
    39
typedef signed char	Sint8;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    40
typedef signed short	Sint16;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    41
typedef signed int	Sint32;
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    42
#else
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    43
typedef unsigned char	Uint8;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    44
typedef signed char	Sint8;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    45
typedef unsigned short	Uint16;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    46
typedef signed short	Sint16;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    47
typedef unsigned int	Uint32;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    48
typedef signed int	Sint32;
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    49
#endif
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    50
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    51
/* Figure out how to support 64-bit datatypes */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    52
#if !defined(__STRICT_ANSI__)
912
bc0b95b02235 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 908
diff changeset
    53
#ifdef __osf__ /* Tru64 */
908
6104bfff77ba Date: Mon, 28 Jun 2004 19:58:08 +0900
Sam Lantinga <slouken@libsdl.org>
parents: 769
diff changeset
    54
#define SDL_HAS_64BIT_TYPE	long
1190
173c063d4f55 OS/2 port!
Ryan C. Gordon <icculus@icculus.org>
parents: 912
diff changeset
    55
#elif defined(__GNUC__) || defined(__MWERKS__) || defined(__SUNPRO_C) || defined(__DECC) || defined(__WATCOMC__)
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    56
#define SDL_HAS_64BIT_TYPE	long long
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    57
#elif defined(_MSC_VER) /* VC++ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    58
#define SDL_HAS_64BIT_TYPE	__int64
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    59
#endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    60
#endif /* !__STRICT_ANSI__ */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    61
173
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
    62
/* 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
    63
#ifdef __SYMBIAN32__
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
    64
#undef SDL_HAS_64BIT_TYPE
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
    65
#endif
83018110dce8 Added initial support for EPOC/Symbian OS (thanks Hannu!)
Sam Lantinga <slouken@libsdl.org>
parents: 166
diff changeset
    66
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    67
/* The 64-bit datatype isn't supported on all platforms */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    68
#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
    69
#ifndef H_MMBASIC
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    70
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
    71
#endif
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    72
typedef SDL_HAS_64BIT_TYPE Sint64;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    73
#else
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    74
/* This is really just a hack to prevent the compiler from complaining */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    75
typedef struct {
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    76
	Uint32 hi;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    77
	Uint32 lo;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    78
} Uint64, Sint64;
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    79
#endif
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    80
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    81
/* Make sure the types really have the right sizes */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    82
#define SDL_COMPILE_TIME_ASSERT(name, x)               \
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    83
       typedef int SDL_dummy_ ## name[(x) * 2 - 1]
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    84
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    85
SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    86
SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    87
SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    88
SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    89
SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    90
SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    91
SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    92
SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
    93
463
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
    94
/* 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
    95
   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
    96
   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
    97
   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
    98
*/
534
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
    99
/* 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
   100
#ifdef __MWERKS__
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
   101
#pragma enumsalwaysint on
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
   102
#endif
1ea658a3dd52 Turn on enums always ints for CodeWarrior (thanks Darrell!)
Sam Lantinga <slouken@libsdl.org>
parents: 463
diff changeset
   103
463
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
   104
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
   105
	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
   106
} 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
   107
bf7389310d27 Added compile-time checking for the size of enums to SDL_types.h
Sam Lantinga <slouken@libsdl.org>
parents: 297
diff changeset
   108
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
   109
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   110
#undef SDL_COMPILE_TIME_ASSERT
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   111
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   112
/* General keyboard/mouse state definitions */
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   113
enum { SDL_PRESSED = 0x01, SDL_RELEASED = 0x00 };
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   114
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
   115
#endif