Mercurial > sdl-ios-xcode
view include/SDL_surface.h @ 4532:dc4a3de60d3a
Logitech G15 on Ubuntu 10.04:
code = 1, sym = 0xFF1B (Escape) scancode = 41 (Escape)
code = 2, sym = 0x31 (1) scancode = 30 (1)
code = 3, sym = 0x32 (2) scancode = 31 (2)
code = 4, sym = 0x33 (3) scancode = 32 (3)
code = 5, sym = 0x34 (4) scancode = 33 (4)
code = 6, sym = 0x35 (5) scancode = 34 (5)
code = 7, sym = 0x36 (6) scancode = 35 (6)
code = 8, sym = 0x37 (7) scancode = 36 (7)
code = 9, sym = 0x38 (8) scancode = 37 (8)
code = 10, sym = 0x39 (9) scancode = 38 (9)
code = 11, sym = 0x30 (0) scancode = 39 (0)
code = 12, sym = 0x2D (minus) scancode = 45 (-)
code = 13, sym = 0x3D (equal) scancode = 46 (=)
code = 14, sym = 0xFF08 (BackSpace) scancode = 42 (Backspace)
code = 15, sym = 0xFF09 (Tab) scancode = 43 (Tab)
code = 16, sym = 0x71 (q) scancode = 20 (Q)
code = 17, sym = 0x77 (w) scancode = 26 (W)
code = 18, sym = 0x65 (e) scancode = 8 (E)
code = 19, sym = 0x72 (r) scancode = 21 (R)
code = 20, sym = 0x74 (t) scancode = 23 (T)
code = 21, sym = 0x79 (y) scancode = 28 (Y)
code = 22, sym = 0x75 (u) scancode = 24 (U)
code = 23, sym = 0x69 (i) scancode = 12 (I)
code = 24, sym = 0x6F (o) scancode = 18 (O)
code = 25, sym = 0x70 (p) scancode = 19 (P)
code = 26, sym = 0x5B (bracketleft) scancode = 47 ([)
code = 27, sym = 0x5D (bracketright) scancode = 48 (])
code = 28, sym = 0xFF0D (Return) scancode = 40 (Return)
code = 29, sym = 0xFFE3 (Control_L) scancode = 224 (Left Ctrl)
code = 30, sym = 0x61 (a) scancode = 4 (A)
code = 31, sym = 0x73 (s) scancode = 22 (S)
code = 32, sym = 0x64 (d) scancode = 7 (D)
code = 33, sym = 0x66 (f) scancode = 9 (F)
code = 34, sym = 0x67 (g) scancode = 10 (G)
code = 35, sym = 0x68 (h) scancode = 11 (H)
code = 36, sym = 0x6A (j) scancode = 13 (J)
code = 37, sym = 0x6B (k) scancode = 14 (K)
code = 38, sym = 0x6C (l) scancode = 15 (L)
code = 39, sym = 0x3B (semicolon) scancode = 51 (;)
code = 40, sym = 0x27 (apostrophe) scancode = 52 (')
code = 41, sym = 0x60 (grave) scancode = 53 (`)
code = 42, sym = 0xFFE1 (Shift_L) scancode = 225 (Left Shift)
code = 43, sym = 0x5C (backslash) scancode = 49 (\)
code = 44, sym = 0x7A (z) scancode = 29 (Z)
code = 45, sym = 0x78 (x) scancode = 27 (X)
code = 46, sym = 0x63 (c) scancode = 6 (C)
code = 47, sym = 0x76 (v) scancode = 25 (V)
code = 48, sym = 0x62 (b) scancode = 5 (B)
code = 49, sym = 0x6E (n) scancode = 17 (N)
code = 50, sym = 0x6D (m) scancode = 16 (M)
code = 51, sym = 0x2C (comma) scancode = 54 (,)
code = 52, sym = 0x2E (period) scancode = 55 (.)
code = 53, sym = 0x2F (slash) scancode = 56 (/)
code = 54, sym = 0xFFE2 (Shift_R) scancode = 229 (Right Shift)
code = 55, sym = 0xFFAA (KP_Multiply) scancode = 85 (Keypad *)
code = 56, sym = 0xFFE9 (Alt_L) scancode = 226 (Left Alt)
code = 57, sym = 0x20 (space) scancode = 44 (Space)
code = 58, sym = 0xFFE5 (Caps_Lock) scancode = 57 (CapsLock)
code = 59, sym = 0xFFBE (F1) scancode = 58 (F1)
code = 60, sym = 0xFFBF (F2) scancode = 59 (F2)
code = 61, sym = 0xFFC0 (F3) scancode = 60 (F3)
code = 62, sym = 0xFFC1 (F4) scancode = 61 (F4)
code = 63, sym = 0xFFC2 (F5) scancode = 62 (F5)
code = 64, sym = 0xFFC3 (F6) scancode = 63 (F6)
code = 65, sym = 0xFFC4 (F7) scancode = 64 (F7)
code = 66, sym = 0xFFC5 (F8) scancode = 65 (F8)
code = 67, sym = 0xFFC6 (F9) scancode = 66 (F9)
code = 68, sym = 0xFFC7 (F10) scancode = 67 (F10)
code = 69, sym = 0xFF7F (Num_Lock) scancode = 83 (Numlock)
code = 70, sym = 0xFF14 (Scroll_Lock) scancode = 71 (ScrollLock)
code = 71, sym = 0xFF95 (KP_Home) scancode = 95 (Keypad 7)
code = 72, sym = 0xFF97 (KP_Up) scancode = 96 (Keypad 8)
code = 73, sym = 0xFF9A (KP_Prior) scancode = 97 (Keypad 9)
code = 74, sym = 0xFFAD (KP_Subtract) scancode = 86 (Keypad -)
code = 75, sym = 0xFF96 (KP_Left) scancode = 92 (Keypad 4)
code = 76, sym = 0xFF9D (KP_Begin) scancode = 93 (Keypad 5)
code = 77, sym = 0xFF98 (KP_Right) scancode = 94 (Keypad 6)
code = 78, sym = 0xFFAB (KP_Add) scancode = 87 (Keypad +)
code = 79, sym = 0xFF9C (KP_End) scancode = 89 (Keypad 1)
code = 80, sym = 0xFF99 (KP_Down) scancode = 90 (Keypad 2)
code = 81, sym = 0xFF9B (KP_Next) scancode = 91 (Keypad 3)
code = 82, sym = 0xFF9E (KP_Insert) scancode = 98 (Keypad 0)
code = 83, sym = 0xFF9F (KP_Delete) scancode = 99 (Keypad .)
code = 84, sym = 0xFE03 (ISO_Level3_Shift) scancode = 0 ()
code = 86, sym = 0x3C (less) scancode not found
code = 87, sym = 0xFFC8 (F11) scancode = 68 (F11)
code = 88, sym = 0xFFC9 (F12) scancode = 69 (F12)
code = 90, sym = 0xFF26 (Katakana) scancode = 0 ()
code = 91, sym = 0xFF25 (Hiragana) scancode = 0 ()
code = 92, sym = 0xFF23 (Henkan_Mode) scancode = 0 ()
code = 93, sym = 0xFF27 (Hiragana_Katakana) scancode = 0 ()
code = 94, sym = 0xFF22 (Muhenkan) scancode = 0 ()
code = 96, sym = 0xFF8D (KP_Enter) scancode = 88 (Keypad Enter)
code = 97, sym = 0xFFE4 (Control_R) scancode = 228 (Right Ctrl)
code = 98, sym = 0xFFAF (KP_Divide) scancode = 84 (Keypad /)
code = 99, sym = 0xFF61 (Print) scancode = 70 (PrintScreen)
code = 100, sym = 0xFFEA (Alt_R) scancode = 230 (Right Alt)
code = 101, sym = 0xFF0A (Linefeed) scancode = 0 ()
code = 102, sym = 0xFF50 (Home) scancode = 74 (Home)
code = 103, sym = 0xFF52 (Up) scancode = 82 (Up)
code = 104, sym = 0xFF55 (Prior) scancode = 75 (PageUp)
code = 105, sym = 0xFF51 (Left) scancode = 80 (Left)
code = 106, sym = 0xFF53 (Right) scancode = 79 (Right)
code = 107, sym = 0xFF57 (End) scancode = 77 (End)
code = 108, sym = 0xFF54 (Down) scancode = 81 (Down)
code = 109, sym = 0xFF56 (Next) scancode = 78 (PageDown)
code = 110, sym = 0xFF63 (Insert) scancode = 73 (Insert)
code = 111, sym = 0xFFFF (Delete) scancode = 76 (Delete)
code = 113, sym = 0x1008FF12 (XF86AudioMute) scancode = 0 ()
code = 114, sym = 0x1008FF11 (XF86AudioLowerVolume) scancode = 0 ()
code = 115, sym = 0x1008FF13 (XF86AudioRaiseVolume) scancode = 0 ()
code = 116, sym = 0x1008FF2A (XF86PowerOff) scancode = 0 ()
code = 117, sym = 0xFFBD (KP_Equal) scancode = 103 (Keypad =)
code = 118, sym = 0xB1 (plusminus) scancode not found
code = 119, sym = 0xFF13 (Pause) scancode = 72 (Pause)
code = 120, sym = 0x1008FF4A (XF86LaunchA) scancode = 0 ()
code = 121, sym = 0xFFAE (KP_Decimal) scancode = 99 (Keypad .)
code = 122, sym = 0xFF31 (Hangul) scancode = 0 ()
code = 123, sym = 0xFF34 (Hangul_Hanja) scancode = 0 ()
code = 125, sym = 0xFFEB (Super_L) scancode = 227 (Left GUI)
code = 126, sym = 0xFFEC (Super_R) scancode = 231 (Right GUI)
code = 127, sym = 0xFF67 (Menu) scancode = 118 (Menu)
code = 128, sym = 0xFF69 (Cancel) scancode = 120 (Stop)
code = 129, sym = 0xFF66 (Redo) scancode = 121 (Again)
code = 130, sym = 0x1005FF70 (SunProps) scancode = 0 ()
code = 131, sym = 0xFF65 (Undo) scancode = 122 (Undo)
code = 132, sym = 0x1005FF71 (SunFront) scancode = 0 ()
code = 133, sym = 0x1008FF57 (XF86Copy) scancode = 0 ()
code = 134, sym = 0x1005FF73 (SunOpen) scancode = 0 ()
code = 135, sym = 0x1008FF6D (XF86Paste) scancode = 0 ()
code = 136, sym = 0xFF68 (Find) scancode = 126 (Find)
code = 137, sym = 0x1008FF58 (XF86Cut) scancode = 0 ()
code = 138, sym = 0xFF6A (Help) scancode = 117 (Help)
code = 139, sym = 0x1008FF65 (XF86MenuKB) scancode = 0 ()
code = 140, sym = 0x1008FF1D (XF86Calculator) scancode = 0 ()
code = 142, sym = 0x1008FF2F (XF86Sleep) scancode = 0 ()
code = 143, sym = 0x1008FF2B (XF86WakeUp) scancode = 0 ()
code = 144, sym = 0x1008FF5D (XF86Explorer) scancode = 0 ()
code = 145, sym = 0x1008FF7B (XF86Send) scancode = 0 ()
code = 147, sym = 0x1008FF8A (XF86Xfer) scancode = 0 ()
code = 148, sym = 0x1008FF41 (XF86Launch1) scancode = 0 ()
code = 149, sym = 0x1008FF42 (XF86Launch2) scancode = 0 ()
code = 150, sym = 0x1008FF2E (XF86WWW) scancode = 0 ()
code = 151, sym = 0x1008FF5A (XF86DOS) scancode = 0 ()
code = 152, sym = 0x1008FF2D (XF86ScreenSaver) scancode = 0 ()
code = 154, sym = 0x1008FF74 (XF86RotateWindows) scancode = 0 ()
code = 155, sym = 0x1008FF19 (XF86Mail) scancode = 0 ()
code = 156, sym = 0x1008FF30 (XF86Favorites) scancode = 0 ()
code = 157, sym = 0x1008FF33 (XF86MyComputer) scancode = 0 ()
code = 158, sym = 0x1008FF26 (XF86Back) scancode = 0 ()
code = 159, sym = 0x1008FF27 (XF86Forward) scancode = 0 ()
code = 161, sym = 0x1008FF2C (XF86Eject) scancode = 0 ()
code = 162, sym = 0x1008FF2C (XF86Eject) scancode = 0 ()
code = 163, sym = 0x1008FF17 (XF86AudioNext) scancode = 0 ()
code = 164, sym = 0x1008FF14 (XF86AudioPlay) scancode = 0 ()
code = 165, sym = 0x1008FF16 (XF86AudioPrev) scancode = 0 ()
code = 166, sym = 0x1008FF15 (XF86AudioStop) scancode = 0 ()
code = 167, sym = 0x1008FF1C (XF86AudioRecord) scancode = 0 ()
code = 168, sym = 0x1008FF3E (XF86AudioRewind) scancode = 0 ()
code = 169, sym = 0x1008FF6E (XF86Phone) scancode = 0 ()
code = 171, sym = 0x1008FF81 (XF86Tools) scancode = 0 ()
code = 172, sym = 0x1008FF18 (XF86HomePage) scancode = 0 ()
code = 173, sym = 0x1008FF73 (XF86Reload) scancode = 0 ()
code = 174, sym = 0x1008FF56 (XF86Close) scancode = 0 ()
code = 177, sym = 0x1008FF78 (XF86ScrollUp) scancode = 0 ()
code = 178, sym = 0x1008FF79 (XF86ScrollDown) scancode = 0 ()
code = 179, sym = 0x28 (parenleft) scancode not found
code = 180, sym = 0x29 (parenright) scancode not found
code = 181, sym = 0x1008FF68 (XF86New) scancode = 0 ()
code = 182, sym = 0xFF66 (Redo) scancode = 121 (Again)
code = 183, sym = 0x1008FF81 (XF86Tools) scancode = 0 ()
code = 184, sym = 0x1008FF45 (XF86Launch5) scancode = 0 ()
code = 185, sym = 0x1008FF65 (XF86MenuKB) scancode = 0 ()
code = 192, sym = 0x1008FFA9 (XF86TouchpadToggle) scancode = 0 ()
code = 195, sym = 0xFF7E (Mode_switch) scancode = 257 (ModeSwitch)
code = 200, sym = 0x1008FF14 (XF86AudioPlay) scancode = 0 ()
code = 201, sym = 0x1008FF31 (XF86AudioPause) scancode = 0 ()
code = 202, sym = 0x1008FF43 (XF86Launch3) scancode = 0 ()
code = 203, sym = 0x1008FF44 (XF86Launch4) scancode = 0 ()
code = 204, sym = 0x1008FF4B (XF86LaunchB) scancode = 0 ()
code = 205, sym = 0x1008FFA7 (XF86Suspend) scancode = 0 ()
code = 206, sym = 0x1008FF56 (XF86Close) scancode = 0 ()
code = 207, sym = 0x1008FF14 (XF86AudioPlay) scancode = 0 ()
code = 208, sym = 0x1008FF97 (XF86AudioForward) scancode = 0 ()
code = 210, sym = 0xFF61 (Print) scancode = 70 (PrintScreen)
code = 212, sym = 0x1008FF8F (XF86WebCam) scancode = 0 ()
code = 215, sym = 0x1008FF19 (XF86Mail) scancode = 0 ()
code = 217, sym = 0x1008FF1B (XF86Search) scancode = 0 ()
code = 219, sym = 0x1008FF3C (XF86Finance) scancode = 0 ()
code = 221, sym = 0x1008FF36 (XF86Shop) scancode = 0 ()
code = 223, sym = 0xFF69 (Cancel) scancode = 120 (Stop)
code = 224, sym = 0x1008FF03 (XF86MonBrightnessDown) scancode = 0 ()
code = 225, sym = 0x1008FF02 (XF86MonBrightnessUp) scancode = 0 ()
code = 226, sym = 0x1008FF32 (XF86AudioMedia) scancode = 0 ()
code = 227, sym = 0x1008FF59 (XF86Display) scancode = 0 ()
code = 228, sym = 0x1008FF04 (XF86KbdLightOnOff) scancode = 0 ()
code = 229, sym = 0x1008FF06 (XF86KbdBrightnessDown) scancode = 0 ()
code = 230, sym = 0x1008FF05 (XF86KbdBrightnessUp) scancode = 0 ()
code = 231, sym = 0x1008FF7B (XF86Send) scancode = 0 ()
code = 232, sym = 0x1008FF72 (XF86Reply) scancode = 0 ()
code = 233, sym = 0x1008FF90 (XF86MailForward) scancode = 0 ()
code = 234, sym = 0x1008FF77 (XF86Save) scancode = 0 ()
code = 235, sym = 0x1008FF5B (XF86Documents) scancode = 0 ()
code = 236, sym = 0x1008FF93 (XF86Battery) scancode = 0 ()
code = 237, sym = 0x1008FF94 (XF86Bluetooth) scancode = 0 ()
code = 238, sym = 0x1008FF95 (XF86WLAN) scancode = 0 ()
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sun, 18 Jul 2010 00:40:17 -0700 |
parents | 274743af0430 |
children | aa8888658021 |
line wrap: on
line source
/* SDL - Simple DirectMedia Layer 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 License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Sam Lantinga slouken@libsdl.org */ /** * \file SDL_surface.h * * Header file for ::SDL_surface definition and management functions. */ #ifndef _SDL_surface_h #define _SDL_surface_h #include "SDL_stdinc.h" #include "SDL_pixels.h" #include "SDL_rect.h" #include "SDL_rwops.h" #include "begin_code.h" /* Set up for C function definitions, even when using C++ */ #ifdef __cplusplus /* *INDENT-OFF* */ extern "C" { /* *INDENT-ON* */ #endif /** * \name Surface flags * * These are the currently supported flags for the ::SDL_surface. * * \internal * Used internally (read-only). */ /*@{*/ #define SDL_PREALLOC 0x00000001 /**< Surface uses preallocated memory */ #define SDL_RLEACCEL 0x00000002 /**< Surface is RLE encoded */ /*@}*//*Surface flags*/ /** * Evaluates to true if the surface needs to be locked before access. */ #define SDL_MUSTLOCK(S) (((S)->flags & SDL_RLEACCEL) != 0) /** * \brief A collection of pixels used in software blitting. * * \note This structure should be treated as read-only, except for \c pixels, * which, if not NULL, contains the raw pixel data for the surface. */ typedef struct SDL_Surface { Uint32 flags; /**< Read-only */ SDL_PixelFormat *format; /**< Read-only */ int w, h; /**< Read-only */ int pitch; /**< Read-only */ void *pixels; /**< Read-write */ /** Application data associated with the surface */ void *userdata; /**< Read-write */ /** information needed for surfaces requiring locks */ int locked; /**< Read-only */ void *lock_data; /**< Read-only */ /** clipping information */ SDL_Rect clip_rect; /**< Read-only */ /** info for fast blit mapping to other surfaces */ struct SDL_BlitMap *map; /**< Private */ /** format version, bumped at every change to invalidate blit maps */ unsigned int format_version; /**< Private */ /** Reference count -- used when freeing surface */ int refcount; /**< Read-mostly */ } SDL_Surface; /** * \brief The type of function used for surface blitting functions. */ typedef int (*SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect, struct SDL_Surface * dst, SDL_Rect * dstrect); /** * Allocate and free an RGB surface. * * If the depth is 4 or 8 bits, an empty palette is allocated for the surface. * If the depth is greater than 8 bits, the pixel format is set using the * flags '[RGB]mask'. * * If the function runs out of memory, it will return NULL. * * \param flags The \c flags are obsolete and should be set to 0. */ extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurface (Uint32 flags, int width, int height, int depth, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); extern DECLSPEC SDL_Surface *SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels, int width, int height, int depth, int pitch, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface * surface); /** * \brief Set the palette used by a surface. * * \return 0, or -1 if the surface format doesn't use a palette. * * \note A single palette can be shared with many surfaces. */ extern DECLSPEC int SDLCALL SDL_SetSurfacePalette(SDL_Surface * surface, SDL_Palette * palette); /** * \brief Sets up a surface for directly accessing the pixels. * * Between calls to SDL_LockSurface() / SDL_UnlockSurface(), you can write * to and read from \c surface->pixels, using the pixel format stored in * \c surface->format. Once you are done accessing the surface, you should * use SDL_UnlockSurface() to release it. * * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates * to 0, then you can read and write to the surface at any time, and the * pixel format of the surface will not change. * * No operating system or library calls should be made between lock/unlock * pairs, as critical system locks may be held during this time. * * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked. * * \sa SDL_UnlockSurface() */ extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface * surface); /** \sa SDL_LockSurface() */ extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface * surface); /** * Load a surface from a seekable SDL data source (memory or file). * * If \c freesrc is non-zero, the source will be closed after being read. * * The new surface should be freed with SDL_FreeSurface(). * * \return the new surface, or NULL if there was an error. */ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_RW(SDL_RWops * src, int freesrc); /** * Load a surface from a file. * * Convenience macro. */ #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1) /** * Save a surface to a seekable SDL data source (memory or file). * * If \c freedst is non-zero, the source will be closed after being written. * * \return 0 if successful or -1 if there was an error. */ extern DECLSPEC int SDLCALL SDL_SaveBMP_RW (SDL_Surface * surface, SDL_RWops * dst, int freedst); /** * Save a surface to a file. * * Convenience macro. */ #define SDL_SaveBMP(surface, file) \ SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1) /** * \brief Sets the RLE acceleration hint for a surface. * * \return 0 on success, or -1 if the surface is not valid * * \note If RLE is enabled, colorkey and alpha blending blits are much faster, * but the surface must be locked before directly accessing the pixels. */ extern DECLSPEC int SDLCALL SDL_SetSurfaceRLE(SDL_Surface * surface, int flag); /** * \brief Sets the color key (transparent pixel) in a blittable surface. * * \param surface The surface to update * \param flag Non-zero to enable colorkey and 0 to disable colorkey * \param key The transparent pixel in the native surface format * * \return 0 on success, or -1 if the surface is not valid */ extern DECLSPEC int SDLCALL SDL_SetColorKey(SDL_Surface * surface, int flag, Uint32 key); /** * \brief Gets the color key (transparent pixel) in a blittable surface. * * \param surface The surface to update * \param key A pointer filled in with the transparent pixel in the native * surface format * * \return 0 on success, or -1 if the surface is not valid or colorkey is not * enabled. */ extern DECLSPEC int SDLCALL SDL_GetColorKey(SDL_Surface * surface, Uint32 * key); /** * \brief Set an additional color value used in blit operations. * * \param surface The surface to update. * \param r The red source color value multiplied into blit operations. * \param g The green source color value multiplied into blit operations. * \param b The blue source color value multiplied into blit operations. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_GetSurfaceColorMod() */ extern DECLSPEC int SDLCALL SDL_SetSurfaceColorMod(SDL_Surface * surface, Uint8 r, Uint8 g, Uint8 b); /** * \brief Get the additional color value used in blit operations. * * \param surface The surface to query. * \param r A pointer filled in with the source red color value. * \param g A pointer filled in with the source green color value. * \param b A pointer filled in with the source blue color value. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_SetSurfaceColorMod() */ extern DECLSPEC int SDLCALL SDL_GetSurfaceColorMod(SDL_Surface * surface, Uint8 * r, Uint8 * g, Uint8 * b); /** * \brief Set an additional alpha value used in blit operations. * * \param surface The surface to update. * \param alpha The source alpha value multiplied into blit operations. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_GetSurfaceAlphaMod() */ extern DECLSPEC int SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface * surface, Uint8 alpha); /** * \brief Get the additional alpha value used in blit operations. * * \param surface The surface to query. * \param alpha A pointer filled in with the source alpha value. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_SetSurfaceAlphaMod() */ extern DECLSPEC int SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface * surface, Uint8 * alpha); /** * \brief Set the blend mode used for blit operations. * * \param surface The surface to update. * \param blendMode ::SDL_BlendMode to use for blit blending. * * \return 0 on success, or -1 if the parameters are not valid. * * \sa SDL_GetSurfaceBlendMode() */ extern DECLSPEC int SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface * surface, int blendMode); /** * \brief Get the blend mode used for blit operations. * * \param surface The surface to query. * \param blendMode A pointer filled in with the current blend mode. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_SetSurfaceBlendMode() */ extern DECLSPEC int SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface * surface, int *blendMode); /** * \brief Set the scale mode used for blit operations. * * \param surface The surface to update. * \param scaleMode ::SDL_TextureScaleMode to use for blit scaling. * * \return 0 on success, or -1 if the surface is not valid or the scale mode is * not supported. * * \note If the scale mode is not supported, the closest supported mode is * chosen. Currently only ::SDL_TEXTURESCALEMODE_FAST is supported on * surfaces. * * \sa SDL_GetSurfaceScaleMode() */ extern DECLSPEC int SDLCALL SDL_SetSurfaceScaleMode(SDL_Surface * surface, int scaleMode); /** * \brief Get the scale mode used for blit operations. * * \param surface The surface to query. * \param scaleMode A pointer filled in with the current scale mode. * * \return 0 on success, or -1 if the surface is not valid. * * \sa SDL_SetSurfaceScaleMode() */ extern DECLSPEC int SDLCALL SDL_GetSurfaceScaleMode(SDL_Surface * surface, int *scaleMode); /** * Sets the clipping rectangle for the destination surface in a blit. * * If the clip rectangle is NULL, clipping will be disabled. * * If the clip rectangle doesn't intersect the surface, the function will * return SDL_FALSE and blits will be completely clipped. Otherwise the * function returns SDL_TRUE and blits to the surface will be clipped to * the intersection of the surface area and the clipping rectangle. * * Note that blits are automatically clipped to the edges of the source * and destination surfaces. */ extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface * surface, const SDL_Rect * rect); /** * Gets the clipping rectangle for the destination surface in a blit. * * \c rect must be a pointer to a valid rectangle which will be filled * with the correct values. */ extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface * surface, SDL_Rect * rect); /** * Creates a new surface of the specified format, and then copies and maps * the given surface to it so the blit of the converted surface will be as * fast as possible. If this function fails, it returns NULL. * * The \c flags parameter is passed to SDL_CreateRGBSurface() and has those * semantics. You can also pass ::SDL_RLEACCEL in the flags parameter and * SDL will try to RLE accelerate colorkey and alpha blits in the resulting * surface. */ extern DECLSPEC SDL_Surface *SDLCALL SDL_ConvertSurface (SDL_Surface * src, SDL_PixelFormat * fmt, Uint32 flags); /** * \brief Copy a block of pixels of one format to another format */ extern DECLSPEC int SDLCALL SDL_ConvertPixels(int width, int height, Uint32 src_format, const void * src, int src_pitch, Uint32 dst_format, void * dst, int dst_pitch); /** * Draws a point with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_DrawPoint (SDL_Surface * dst, int x, int y, Uint32 color); extern DECLSPEC int SDLCALL SDL_DrawPoints (SDL_Surface * dst, const SDL_Point * points, int count, Uint32 color); /** * Blends a point with an RGBA value. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendPoint (SDL_Surface * dst, int x, int y, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); extern DECLSPEC int SDLCALL SDL_BlendPoints (SDL_Surface * dst, const SDL_Point * points, int count, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Draws a line with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_DrawLine (SDL_Surface * dst, int x1, int y1, int x2, int y2, Uint32 color); extern DECLSPEC int SDLCALL SDL_DrawLines (SDL_Surface * dst, const SDL_Point * points, int count, Uint32 color); /** * Blends an RGBA value along a line. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendLine (SDL_Surface * dst, int x1, int y1, int x2, int y2, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); extern DECLSPEC int SDLCALL SDL_BlendLines (SDL_Surface * dst, const SDL_Point * points, int count, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Draws the given rectangle with \c color. * * If \c rect is NULL, the whole surface will be outlined with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_DrawRect (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color); extern DECLSPEC int SDLCALL SDL_DrawRects (SDL_Surface * dst, const SDL_Rect ** rects, int count, Uint32 color); /** * Blends an RGBA value into the outline of the given rectangle. * * If \c rect is NULL, the whole surface will have a blended outline. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendRect (SDL_Surface * dst, const SDL_Rect * rect, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); extern DECLSPEC int SDLCALL SDL_BlendRects (SDL_Surface * dst, const SDL_Rect ** rects, int count, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Performs a fast fill of the given rectangle with \c color. * * If \c rect is NULL, the whole surface will be filled with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_FillRect (SDL_Surface * dst, const SDL_Rect * rect, Uint32 color); extern DECLSPEC int SDLCALL SDL_FillRects (SDL_Surface * dst, const SDL_Rect ** rects, int count, Uint32 color); /** * Blends an RGBA value into the given rectangle. * * If \c rect is NULL, the whole surface will be blended with the color. * * \return This function returns 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendFillRect (SDL_Surface * dst, const SDL_Rect * rect, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); extern DECLSPEC int SDLCALL SDL_BlendFillRects (SDL_Surface * dst, const SDL_Rect ** rects, int count, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); #if 0 /** * Draws the given circle with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_DrawCircle (SDL_Surface * dst, int x, int y, int radius, Uint32 color); /** * Blends an RGBA value into the outline of the given circle. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendCircle (SDL_Surface * dst, int x, int y, int radius, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Fills the given circle with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_FillCircle (SDL_Surface * dst, int x, int y, int radius, Uint32 color); /** * Blends an RGBA value into the given circle. * * \return This function returns 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendFillCircle (SDL_Surface * dst, int x, int y, int radius, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Draws the given ellipse with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_DrawEllipse (SDL_Surface * dst, int x, int y, int w, int h, Uint32 color); /** * Blends an RGBA value into the outline of the given ellipse. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendEllipse (SDL_Surface * dst, int x, int y, int w, int h, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); /** * Fills the given ellipse with \c color. * * The color should be a pixel of the format used by the surface, and * can be generated by the SDL_MapRGB() function. * * \return 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_FillEllipse (SDL_Surface * dst, int x, int y, int w, int h, Uint32 color); /** * Blends an RGBA value into the given ellipse. * * \return This function returns 0 on success, or -1 on error. */ extern DECLSPEC int SDLCALL SDL_BlendFillEllipse (SDL_Surface * dst, int x, int y, int w, int h, int blendMode, Uint8 r, Uint8 g, Uint8 b, Uint8 a); #endif // 0 /** * Performs a fast blit from the source surface to the destination surface. * * This assumes that the source and destination rectangles are * the same size. If either \c srcrect or \c dstrect are NULL, the entire * surface (\c src or \c dst) is copied. The final blit rectangles are saved * in \c srcrect and \c dstrect after all clipping is performed. * * \return If the blit is successful, it returns 0, otherwise it returns -1. * * The blit function should not be called on a locked surface. * * The blit semantics for surfaces with and without alpha and colorkey * are defined as follows: * \verbatim RGBA->RGB: SDL_SRCALPHA set: alpha-blend (using alpha-channel). SDL_SRCCOLORKEY ignored. SDL_SRCALPHA not set: copy RGB. if SDL_SRCCOLORKEY set, only copy the pixels matching the RGB values of the source colour key, ignoring alpha in the comparison. RGB->RGBA: SDL_SRCALPHA set: alpha-blend (using the source per-surface alpha value); set destination alpha to opaque. SDL_SRCALPHA not set: copy RGB, set destination alpha to source per-surface alpha value. both: if SDL_SRCCOLORKEY set, only copy the pixels matching the source colour key. RGBA->RGBA: SDL_SRCALPHA set: alpha-blend (using the source alpha channel) the RGB values; leave destination alpha untouched. [Note: is this correct?] SDL_SRCCOLORKEY ignored. SDL_SRCALPHA not set: copy all of RGBA to the destination. if SDL_SRCCOLORKEY set, only copy the pixels matching the RGB values of the source colour key, ignoring alpha in the comparison. RGB->RGB: SDL_SRCALPHA set: alpha-blend (using the source per-surface alpha value). SDL_SRCALPHA not set: copy RGB. both: if SDL_SRCCOLORKEY set, only copy the pixels matching the source colour key. \endverbatim * * If either of the surfaces were in video memory, and the blit returns -2, * the video memory was lost, so it should be reloaded with artwork and * re-blitted: * @code * while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) { * while ( SDL_LockSurface(image) < 0 ) * Sleep(10); * -- Write image pixels to image->pixels -- * SDL_UnlockSurface(image); * } * @endcode * * This happens under DirectX 5.0 when the system switches away from your * fullscreen application. The lock will also fail until you have access * to the video memory again. * * You should call SDL_BlitSurface() unless you know exactly how SDL * blitting works internally and how to use the other blit functions. */ #define SDL_BlitSurface SDL_UpperBlit /** * This is the public blit function, SDL_BlitSurface(), and it performs * rectangle validation and clipping before passing it to SDL_LowerBlit() */ extern DECLSPEC int SDLCALL SDL_UpperBlit (SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect); /** * This is a semi-private blit function and it performs low-level surface * blitting only. */ extern DECLSPEC int SDLCALL SDL_LowerBlit (SDL_Surface * src, SDL_Rect * srcrect, SDL_Surface * dst, SDL_Rect * dstrect); /** * \brief Perform a fast, low quality, stretch blit between two surfaces of the * same pixel format. * * \note This function uses a static buffer, and is not thread-safe. */ extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface * src, const SDL_Rect * srcrect, SDL_Surface * dst, const SDL_Rect * dstrect); /* Ends C function definitions when using C++ */ #ifdef __cplusplus /* *INDENT-OFF* */ } /* *INDENT-ON* */ #endif #include "close_code.h" #endif /* _SDL_surface_h */ /* vi: set ts=4 sw=4 expandtab: */