Mercurial > sdl-ios-xcode
annotate include/SDL_video.h @ 1737:eacc5bc01d1c
Implemented bug #5
Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Thu, 27 Apr 2006 08:39:51 +0000 |
parents | 3b2a92126f4d |
children | c121d94672cb cd5b5c52a37e |
rev | line source |
---|---|
0 | 1 /* |
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:
1020
diff
changeset
|
3 Copyright (C) 1997-2006 Sam Lantinga |
0 | 4 |
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:
1020
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
0 | 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:
1020
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
0 | 9 |
10 This library is distributed in the hope that it will be useful, | |
11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
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:
1020
diff
changeset
|
13 Lesser General Public License for more details. |
0 | 14 |
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1020
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:
1020
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:
1020
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
0 | 18 |
19 Sam Lantinga | |
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
130
diff
changeset
|
20 slouken@libsdl.org |
0 | 21 */ |
22 | |
23 /* Header file for access to the SDL raw framebuffer window */ | |
24 | |
25 #ifndef _SDL_video_h | |
26 #define _SDL_video_h | |
27 | |
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1330
diff
changeset
|
28 #include "SDL_stdinc.h" |
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
29 #include "SDL_error.h" |
0 | 30 #include "SDL_rwops.h" |
31 | |
32 #include "begin_code.h" | |
33 /* Set up for C function definitions, even when using C++ */ | |
34 #ifdef __cplusplus | |
35 extern "C" { | |
36 #endif | |
37 | |
38 /* Transparency definitions: These define alpha as the opacity of a surface */ | |
39 #define SDL_ALPHA_OPAQUE 255 | |
40 #define SDL_ALPHA_TRANSPARENT 0 | |
41 | |
42 /* Useful data types */ | |
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
43 typedef struct SDL_Rect { |
0 | 44 Sint16 x, y; |
45 Uint16 w, h; | |
46 } SDL_Rect; | |
47 | |
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
48 typedef struct SDL_Color { |
0 | 49 Uint8 r; |
50 Uint8 g; | |
51 Uint8 b; | |
52 Uint8 unused; | |
53 } SDL_Color; | |
639
6961e1c84e76
I'm American, does it show? ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
450
diff
changeset
|
54 #define SDL_Colour SDL_Color |
0 | 55 |
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
56 typedef struct SDL_Palette { |
0 | 57 int ncolors; |
58 SDL_Color *colors; | |
59 } SDL_Palette; | |
60 | |
61 /* Everything in the pixel format structure is read-only */ | |
62 typedef struct SDL_PixelFormat { | |
63 SDL_Palette *palette; | |
64 Uint8 BitsPerPixel; | |
65 Uint8 BytesPerPixel; | |
66 Uint8 Rloss; | |
67 Uint8 Gloss; | |
68 Uint8 Bloss; | |
69 Uint8 Aloss; | |
70 Uint8 Rshift; | |
71 Uint8 Gshift; | |
72 Uint8 Bshift; | |
73 Uint8 Ashift; | |
74 Uint32 Rmask; | |
75 Uint32 Gmask; | |
76 Uint32 Bmask; | |
77 Uint32 Amask; | |
78 | |
79 /* RGB color key information */ | |
80 Uint32 colorkey; | |
81 /* Alpha value information (per-surface alpha) */ | |
82 Uint8 alpha; | |
83 } SDL_PixelFormat; | |
84 | |
85 /* This structure should be treated as read-only, except for 'pixels', | |
86 which, if not NULL, contains the raw pixel data for the surface. | |
87 */ | |
88 typedef struct SDL_Surface { | |
89 Uint32 flags; /* Read-only */ | |
90 SDL_PixelFormat *format; /* Read-only */ | |
91 int w, h; /* Read-only */ | |
92 Uint16 pitch; /* Read-only */ | |
93 void *pixels; /* Read-write */ | |
94 int offset; /* Private */ | |
95 | |
96 /* Hardware-specific surface info */ | |
97 struct private_hwdata *hwdata; | |
98 | |
99 /* clipping information */ | |
100 SDL_Rect clip_rect; /* Read-only */ | |
101 Uint32 unused1; /* for binary compatibility */ | |
102 | |
103 /* Allow recursive locks */ | |
104 Uint32 locked; /* Private */ | |
105 | |
106 /* info for fast blit mapping to other surfaces */ | |
107 struct SDL_BlitMap *map; /* Private */ | |
108 | |
109 /* format version, bumped at every change to invalidate blit maps */ | |
110 unsigned int format_version; /* Private */ | |
111 | |
112 /* Reference count -- used when freeing surface */ | |
113 int refcount; /* Read-mostly */ | |
114 } SDL_Surface; | |
115 | |
116 /* These are the currently supported flags for the SDL_surface */ | |
117 /* Available for SDL_CreateRGBSurface() or SDL_SetVideoMode() */ | |
118 #define SDL_SWSURFACE 0x00000000 /* Surface is in system memory */ | |
119 #define SDL_HWSURFACE 0x00000001 /* Surface is in video memory */ | |
120 #define SDL_ASYNCBLIT 0x00000004 /* Use asynchronous blits if possible */ | |
121 /* Available for SDL_SetVideoMode() */ | |
122 #define SDL_ANYFORMAT 0x10000000 /* Allow any video depth/pixel-format */ | |
123 #define SDL_HWPALETTE 0x20000000 /* Surface has exclusive palette */ | |
124 #define SDL_DOUBLEBUF 0x40000000 /* Set up double-buffered video mode */ | |
125 #define SDL_FULLSCREEN 0x80000000 /* Surface is a full screen display */ | |
126 #define SDL_OPENGL 0x00000002 /* Create an OpenGL rendering context */ | |
127 #define SDL_OPENGLBLIT 0x0000000A /* Create an OpenGL rendering context and use it for blitting */ | |
128 #define SDL_RESIZABLE 0x00000010 /* This video mode may be resized */ | |
129 #define SDL_NOFRAME 0x00000020 /* No window caption or edge frame */ | |
130 /* Used internally (read-only) */ | |
131 #define SDL_HWACCEL 0x00000100 /* Blit uses hardware acceleration */ | |
132 #define SDL_SRCCOLORKEY 0x00001000 /* Blit uses a source color key */ | |
133 #define SDL_RLEACCELOK 0x00002000 /* Private flag */ | |
134 #define SDL_RLEACCEL 0x00004000 /* Surface is RLE encoded */ | |
135 #define SDL_SRCALPHA 0x00010000 /* Blit uses source alpha blending */ | |
136 #define SDL_PREALLOC 0x01000000 /* Surface uses preallocated memory */ | |
137 | |
138 /* Evaluates to true if the surface needs to be locked before access */ | |
139 #define SDL_MUSTLOCK(surface) \ | |
140 (surface->offset || \ | |
141 ((surface->flags & (SDL_HWSURFACE|SDL_ASYNCBLIT|SDL_RLEACCEL)) != 0)) | |
142 | |
1020
5b1cb1e9140d
Allow SDL to be loaded by Matlab
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
143 /* typedef for private surface blitting functions */ |
5b1cb1e9140d
Allow SDL to be loaded by Matlab
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
144 typedef int (*SDL_blit)(struct SDL_Surface *src, SDL_Rect *srcrect, |
5b1cb1e9140d
Allow SDL to be loaded by Matlab
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
145 struct SDL_Surface *dst, SDL_Rect *dstrect); |
5b1cb1e9140d
Allow SDL to be loaded by Matlab
Sam Lantinga <slouken@libsdl.org>
parents:
911
diff
changeset
|
146 |
0 | 147 |
148 /* Useful for determining the video hardware capabilities */ | |
911
04a403e4ccf5
Date: Mon, 3 May 2004 03:15:01 +0100
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
149 typedef struct SDL_VideoInfo { |
0 | 150 Uint32 hw_available :1; /* Flag: Can you create hardware surfaces? */ |
151 Uint32 wm_available :1; /* Flag: Can you talk to a window manager? */ | |
152 Uint32 UnusedBits1 :6; | |
153 Uint32 UnusedBits2 :1; | |
154 Uint32 blit_hw :1; /* Flag: Accelerated blits HW --> HW */ | |
155 Uint32 blit_hw_CC :1; /* Flag: Accelerated blits with Colorkey */ | |
156 Uint32 blit_hw_A :1; /* Flag: Accelerated blits with Alpha */ | |
157 Uint32 blit_sw :1; /* Flag: Accelerated blits SW --> HW */ | |
158 Uint32 blit_sw_CC :1; /* Flag: Accelerated blits with Colorkey */ | |
159 Uint32 blit_sw_A :1; /* Flag: Accelerated blits with Alpha */ | |
160 Uint32 blit_fill :1; /* Flag: Accelerated color fill */ | |
161 Uint32 UnusedBits3 :16; | |
162 Uint32 video_mem; /* The total amount of video memory (in K) */ | |
163 SDL_PixelFormat *vfmt; /* Value: The format of the video surface */ | |
1545
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1505
diff
changeset
|
164 int current_w; /* Value: The current video mode width */ |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1505
diff
changeset
|
165 int current_h; /* Value: The current video mode height */ |
0 | 166 } SDL_VideoInfo; |
167 | |
168 | |
169 /* The most common video overlay formats. | |
170 For an explanation of these pixel formats, see: | |
171 http://www.webartz.com/fourcc/indexyuv.htm | |
172 | |
173 For information on the relationship between color spaces, see: | |
174 http://www.neuro.sfc.keio.ac.jp/~aly/polygon/info/color-space-faq.html | |
175 */ | |
176 #define SDL_YV12_OVERLAY 0x32315659 /* Planar mode: Y + V + U (3 planes) */ | |
177 #define SDL_IYUV_OVERLAY 0x56555949 /* Planar mode: Y + U + V (3 planes) */ | |
178 #define SDL_YUY2_OVERLAY 0x32595559 /* Packed mode: Y0+U0+Y1+V0 (1 plane) */ | |
179 #define SDL_UYVY_OVERLAY 0x59565955 /* Packed mode: U0+Y0+V0+Y1 (1 plane) */ | |
180 #define SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 (1 plane) */ | |
181 | |
182 /* The YUV hardware video overlay */ | |
183 typedef struct SDL_Overlay { | |
184 Uint32 format; /* Read-only */ | |
185 int w, h; /* Read-only */ | |
186 int planes; /* Read-only */ | |
187 Uint16 *pitches; /* Read-only */ | |
188 Uint8 **pixels; /* Read-write */ | |
189 | |
190 /* Hardware-specific surface info */ | |
191 struct private_yuvhwfuncs *hwfuncs; | |
192 struct private_yuvhwdata *hwdata; | |
193 | |
194 /* Special flags */ | |
195 Uint32 hw_overlay :1; /* Flag: This overlay hardware accelerated? */ | |
196 Uint32 UnusedBits :31; | |
197 } SDL_Overlay; | |
198 | |
199 | |
200 /* Public enumeration for setting the OpenGL window attributes. */ | |
201 typedef enum { | |
202 SDL_GL_RED_SIZE, | |
203 SDL_GL_GREEN_SIZE, | |
204 SDL_GL_BLUE_SIZE, | |
205 SDL_GL_ALPHA_SIZE, | |
206 SDL_GL_BUFFER_SIZE, | |
207 SDL_GL_DOUBLEBUFFER, | |
208 SDL_GL_DEPTH_SIZE, | |
209 SDL_GL_STENCIL_SIZE, | |
210 SDL_GL_ACCUM_RED_SIZE, | |
211 SDL_GL_ACCUM_GREEN_SIZE, | |
212 SDL_GL_ACCUM_BLUE_SIZE, | |
450
8a43e0cbf02f
Added SDL_GL_STEREO for stereoscopic OpenGL contexts
Sam Lantinga <slouken@libsdl.org>
parents:
432
diff
changeset
|
213 SDL_GL_ACCUM_ALPHA_SIZE, |
655
9c42ee1b7d77
Date: Thu, 24 Apr 2003 15:13:47 -0400
Sam Lantinga <slouken@libsdl.org>
parents:
639
diff
changeset
|
214 SDL_GL_STEREO, |
656
864e2d2a9a55
Merged in Ryan's multisample code for MacOS, and changed the constants to match.
Sam Lantinga <slouken@libsdl.org>
parents:
655
diff
changeset
|
215 SDL_GL_MULTISAMPLEBUFFERS, |
1736
3b2a92126f4d
Implemented bug #2, 117:
Sam Lantinga <slouken@libsdl.org>
parents:
1545
diff
changeset
|
216 SDL_GL_MULTISAMPLESAMPLES, |
1737 | 217 SDL_GL_ACCELERATED_VISUAL, |
1736
3b2a92126f4d
Implemented bug #2, 117:
Sam Lantinga <slouken@libsdl.org>
parents:
1545
diff
changeset
|
218 SDL_GL_SWAP_CONTROL |
0 | 219 } SDL_GLattr; |
220 | |
221 /* flags for SDL_SetPalette() */ | |
222 #define SDL_LOGPAL 0x01 | |
223 #define SDL_PHYSPAL 0x02 | |
224 | |
225 /* Function prototypes */ | |
226 | |
227 /* These functions are used internally, and should not be used unless you | |
228 * have a specific need to specify the video driver you want to use. | |
229 * You should normally use SDL_Init() or SDL_InitSubSystem(). | |
230 * | |
231 * SDL_VideoInit() initializes the video subsystem -- sets up a connection | |
232 * to the window manager, etc, and determines the current video mode and | |
233 * pixel format, but does not initialize a window or graphics mode. | |
234 * Note that event handling is activated by this routine. | |
235 * | |
236 * If you use both sound and video in your application, you need to call | |
237 * SDL_Init() before opening the sound device, otherwise under Win32 DirectX, | |
238 * you won't be able to set full-screen display modes. | |
239 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
240 extern DECLSPEC int SDLCALL SDL_VideoInit(const char *driver_name, Uint32 flags); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
241 extern DECLSPEC void SDLCALL SDL_VideoQuit(void); |
0 | 242 |
243 /* This function fills the given character buffer with the name of the | |
244 * video driver, and returns a pointer to it if the video driver has | |
245 * been initialized. It returns NULL if no driver has been initialized. | |
246 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
247 extern DECLSPEC char * SDLCALL SDL_VideoDriverName(char *namebuf, int maxlen); |
0 | 248 |
249 /* | |
250 * This function returns a pointer to the current display surface. | |
251 * If SDL is doing format conversion on the display surface, this | |
252 * function returns the publicly visible surface, not the real video | |
253 * surface. | |
254 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
255 extern DECLSPEC SDL_Surface * SDLCALL SDL_GetVideoSurface(void); |
0 | 256 |
257 /* | |
258 * This function returns a read-only pointer to information about the | |
259 * video hardware. If this is called before SDL_SetVideoMode(), the 'vfmt' | |
260 * member of the returned structure will contain the pixel format of the | |
261 * "best" video mode. | |
262 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
263 extern DECLSPEC const SDL_VideoInfo * SDLCALL SDL_GetVideoInfo(void); |
0 | 264 |
265 /* | |
266 * Check to see if a particular video mode is supported. | |
267 * It returns 0 if the requested mode is not supported under any bit depth, | |
268 * or returns the bits-per-pixel of the closest available mode with the | |
269 * given width and height. If this bits-per-pixel is different from the | |
270 * one used when setting the video mode, SDL_SetVideoMode() will succeed, | |
271 * but will emulate the requested bits-per-pixel with a shadow surface. | |
272 * | |
273 * The arguments to SDL_VideoModeOK() are the same ones you would pass to | |
274 * SDL_SetVideoMode() | |
275 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
276 extern DECLSPEC int SDLCALL SDL_VideoModeOK(int width, int height, int bpp, Uint32 flags); |
0 | 277 |
278 /* | |
279 * Return a pointer to an array of available screen dimensions for the | |
280 * given format and video flags, sorted largest to smallest. Returns | |
281 * NULL if there are no dimensions available for a particular format, | |
282 * or (SDL_Rect **)-1 if any dimension is okay for the given format. | |
283 * | |
284 * If 'format' is NULL, the mode list will be for the format given | |
285 * by SDL_GetVideoInfo()->vfmt | |
286 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
287 extern DECLSPEC SDL_Rect ** SDLCALL SDL_ListModes(SDL_PixelFormat *format, Uint32 flags); |
0 | 288 |
289 /* | |
290 * Set up a video mode with the specified width, height and bits-per-pixel. | |
291 * | |
292 * If 'bpp' is 0, it is treated as the current display bits per pixel. | |
293 * | |
294 * If SDL_ANYFORMAT is set in 'flags', the SDL library will try to set the | |
295 * requested bits-per-pixel, but will return whatever video pixel format is | |
296 * available. The default is to emulate the requested pixel format if it | |
297 * is not natively available. | |
298 * | |
299 * If SDL_HWSURFACE is set in 'flags', the video surface will be placed in | |
300 * video memory, if possible, and you may have to call SDL_LockSurface() | |
301 * in order to access the raw framebuffer. Otherwise, the video surface | |
302 * will be created in system memory. | |
303 * | |
304 * If SDL_ASYNCBLIT is set in 'flags', SDL will try to perform rectangle | |
305 * updates asynchronously, but you must always lock before accessing pixels. | |
306 * SDL will wait for updates to complete before returning from the lock. | |
307 * | |
308 * If SDL_HWPALETTE is set in 'flags', the SDL library will guarantee | |
309 * that the colors set by SDL_SetColors() will be the colors you get. | |
310 * Otherwise, in 8-bit mode, SDL_SetColors() may not be able to set all | |
311 * of the colors exactly the way they are requested, and you should look | |
312 * at the video surface structure to determine the actual palette. | |
313 * If SDL cannot guarantee that the colors you request can be set, | |
314 * i.e. if the colormap is shared, then the video surface may be created | |
315 * under emulation in system memory, overriding the SDL_HWSURFACE flag. | |
316 * | |
317 * If SDL_FULLSCREEN is set in 'flags', the SDL library will try to set | |
318 * a fullscreen video mode. The default is to create a windowed mode | |
319 * if the current graphics system has a window manager. | |
320 * If the SDL library is able to set a fullscreen video mode, this flag | |
321 * will be set in the surface that is returned. | |
322 * | |
323 * If SDL_DOUBLEBUF is set in 'flags', the SDL library will try to set up | |
324 * two surfaces in video memory and swap between them when you call | |
325 * SDL_Flip(). This is usually slower than the normal single-buffering | |
326 * scheme, but prevents "tearing" artifacts caused by modifying video | |
327 * memory while the monitor is refreshing. It should only be used by | |
328 * applications that redraw the entire screen on every update. | |
329 * | |
330 * If SDL_RESIZABLE is set in 'flags', the SDL library will allow the | |
331 * window manager, if any, to resize the window at runtime. When this | |
332 * occurs, SDL will send a SDL_VIDEORESIZE event to you application, | |
333 * and you must respond to the event by re-calling SDL_SetVideoMode() | |
334 * with the requested size (or another size that suits the application). | |
335 * | |
336 * If SDL_NOFRAME is set in 'flags', the SDL library will create a window | |
337 * without any title bar or frame decoration. Fullscreen video modes have | |
338 * this flag set automatically. | |
339 * | |
340 * This function returns the video framebuffer surface, or NULL if it fails. | |
341 * | |
342 * If you rely on functionality provided by certain video flags, check the | |
343 * flags of the returned surface to make sure that functionality is available. | |
344 * SDL will fall back to reduced functionality if the exact flags you wanted | |
345 * are not available. | |
346 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
347 extern DECLSPEC SDL_Surface * SDLCALL SDL_SetVideoMode |
0 | 348 (int width, int height, int bpp, Uint32 flags); |
349 | |
350 /* | |
351 * Makes sure the given list of rectangles is updated on the given screen. | |
352 * If 'x', 'y', 'w' and 'h' are all 0, SDL_UpdateRect will update the entire | |
353 * screen. | |
354 * These functions should not be called while 'screen' is locked. | |
355 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
356 extern DECLSPEC void SDLCALL SDL_UpdateRects |
0 | 357 (SDL_Surface *screen, int numrects, SDL_Rect *rects); |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
358 extern DECLSPEC void SDLCALL SDL_UpdateRect |
0 | 359 (SDL_Surface *screen, Sint32 x, Sint32 y, Uint32 w, Uint32 h); |
360 | |
361 /* | |
362 * On hardware that supports double-buffering, this function sets up a flip | |
363 * and returns. The hardware will wait for vertical retrace, and then swap | |
364 * video buffers before the next video surface blit or lock will return. | |
365 * On hardware that doesn not support double-buffering, this is equivalent | |
366 * to calling SDL_UpdateRect(screen, 0, 0, 0, 0); | |
367 * The SDL_DOUBLEBUF flag must have been passed to SDL_SetVideoMode() when | |
368 * setting the video mode for this function to perform hardware flipping. | |
369 * This function returns 0 if successful, or -1 if there was an error. | |
370 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
371 extern DECLSPEC int SDLCALL SDL_Flip(SDL_Surface *screen); |
0 | 372 |
373 /* | |
374 * Set the gamma correction for each of the color channels. | |
375 * The gamma values range (approximately) between 0.1 and 10.0 | |
376 * | |
377 * If this function isn't supported directly by the hardware, it will | |
378 * be emulated using gamma ramps, if available. If successful, this | |
379 * function returns 0, otherwise it returns -1. | |
380 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
381 extern DECLSPEC int SDLCALL SDL_SetGamma(float red, float green, float blue); |
0 | 382 |
383 /* | |
384 * Set the gamma translation table for the red, green, and blue channels | |
385 * of the video hardware. Each table is an array of 256 16-bit quantities, | |
386 * representing a mapping between the input and output for that channel. | |
387 * The input is the index into the array, and the output is the 16-bit | |
388 * gamma value at that index, scaled to the output color precision. | |
389 * | |
390 * You may pass NULL for any of the channels to leave it unchanged. | |
391 * If the call succeeds, it will return 0. If the display driver or | |
392 * hardware does not support gamma translation, or otherwise fails, | |
393 * this function will return -1. | |
394 */ | |
665
d27aab66c5d6
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
656
diff
changeset
|
395 extern DECLSPEC int SDLCALL SDL_SetGammaRamp(const Uint16 *red, const Uint16 *green, const Uint16 *blue); |
0 | 396 |
397 /* | |
398 * Retrieve the current values of the gamma translation tables. | |
399 * | |
400 * You must pass in valid pointers to arrays of 256 16-bit quantities. | |
401 * Any of the pointers may be NULL to ignore that channel. | |
402 * If the call succeeds, it will return 0. If the display driver or | |
403 * hardware does not support gamma translation, or otherwise fails, | |
404 * this function will return -1. | |
405 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
406 extern DECLSPEC int SDLCALL SDL_GetGammaRamp(Uint16 *red, Uint16 *green, Uint16 *blue); |
0 | 407 |
408 /* | |
409 * Sets a portion of the colormap for the given 8-bit surface. If 'surface' | |
410 * is not a palettized surface, this function does nothing, returning 0. | |
411 * If all of the colors were set as passed to SDL_SetColors(), it will | |
412 * return 1. If not all the color entries were set exactly as given, | |
413 * it will return 0, and you should look at the surface palette to | |
414 * determine the actual color palette. | |
415 * | |
416 * When 'surface' is the surface associated with the current display, the | |
417 * display colormap will be updated with the requested colors. If | |
418 * SDL_HWPALETTE was set in SDL_SetVideoMode() flags, SDL_SetColors() | |
419 * will always return 1, and the palette is guaranteed to be set the way | |
420 * you desire, even if the window colormap has to be warped or run under | |
421 * emulation. | |
422 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
423 extern DECLSPEC int SDLCALL SDL_SetColors(SDL_Surface *surface, |
0 | 424 SDL_Color *colors, int firstcolor, int ncolors); |
425 | |
426 /* | |
427 * Sets a portion of the colormap for a given 8-bit surface. | |
428 * 'flags' is one or both of: | |
429 * SDL_LOGPAL -- set logical palette, which controls how blits are mapped | |
430 * to/from the surface, | |
431 * SDL_PHYSPAL -- set physical palette, which controls how pixels look on | |
432 * the screen | |
433 * Only screens have physical palettes. Separate change of physical/logical | |
434 * palettes is only possible if the screen has SDL_HWPALETTE set. | |
435 * | |
436 * The return value is 1 if all colours could be set as requested, and 0 | |
437 * otherwise. | |
438 * | |
439 * SDL_SetColors() is equivalent to calling this function with | |
440 * flags = (SDL_LOGPAL|SDL_PHYSPAL). | |
441 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
442 extern DECLSPEC int SDLCALL SDL_SetPalette(SDL_Surface *surface, int flags, |
0 | 443 SDL_Color *colors, int firstcolor, |
444 int ncolors); | |
445 | |
446 /* | |
447 * Maps an RGB triple to an opaque pixel value for a given pixel format | |
448 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
449 extern DECLSPEC Uint32 SDLCALL SDL_MapRGB |
0 | 450 (SDL_PixelFormat *format, Uint8 r, Uint8 g, Uint8 b); |
451 | |
452 /* | |
453 * Maps an RGBA quadruple to a pixel value for a given pixel format | |
454 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
455 extern DECLSPEC Uint32 SDLCALL SDL_MapRGBA(SDL_PixelFormat *format, |
0 | 456 Uint8 r, Uint8 g, Uint8 b, Uint8 a); |
457 | |
458 /* | |
459 * Maps a pixel value into the RGB components for a given pixel format | |
460 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
461 extern DECLSPEC void SDLCALL SDL_GetRGB(Uint32 pixel, SDL_PixelFormat *fmt, |
0 | 462 Uint8 *r, Uint8 *g, Uint8 *b); |
463 | |
464 /* | |
465 * Maps a pixel value into the RGBA components for a given pixel format | |
466 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
467 extern DECLSPEC void SDLCALL SDL_GetRGBA(Uint32 pixel, SDL_PixelFormat *fmt, |
0 | 468 Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a); |
469 | |
470 /* | |
471 * Allocate and free an RGB surface (must be called after SDL_SetVideoMode) | |
472 * If the depth is 4 or 8 bits, an empty palette is allocated for the surface. | |
473 * If the depth is greater than 8 bits, the pixel format is set using the | |
474 * flags '[RGB]mask'. | |
475 * If the function runs out of memory, it will return NULL. | |
476 * | |
477 * The 'flags' tell what kind of surface to create. | |
478 * SDL_SWSURFACE means that the surface should be created in system memory. | |
479 * SDL_HWSURFACE means that the surface should be created in video memory, | |
480 * with the same format as the display surface. This is useful for surfaces | |
481 * that will not change much, to take advantage of hardware acceleration | |
482 * when being blitted to the display surface. | |
483 * SDL_ASYNCBLIT means that SDL will try to perform asynchronous blits with | |
484 * this surface, but you must always lock it before accessing the pixels. | |
485 * SDL will wait for current blits to finish before returning from the lock. | |
486 * SDL_SRCCOLORKEY indicates that the surface will be used for colorkey blits. | |
487 * If the hardware supports acceleration of colorkey blits between | |
488 * two surfaces in video memory, SDL will try to place the surface in | |
489 * video memory. If this isn't possible or if there is no hardware | |
490 * acceleration available, the surface will be placed in system memory. | |
491 * SDL_SRCALPHA means that the surface will be used for alpha blits and | |
492 * if the hardware supports hardware acceleration of alpha blits between | |
493 * two surfaces in video memory, to place the surface in video memory | |
494 * if possible, otherwise it will be placed in system memory. | |
495 * If the surface is created in video memory, blits will be _much_ faster, | |
496 * but the surface format must be identical to the video surface format, | |
497 * and the only way to access the pixels member of the surface is to use | |
498 * the SDL_LockSurface() and SDL_UnlockSurface() calls. | |
499 * If the requested surface actually resides in video memory, SDL_HWSURFACE | |
500 * will be set in the flags member of the returned surface. If for some | |
501 * reason the surface could not be placed in video memory, it will not have | |
502 * the SDL_HWSURFACE flag set, and will be created in system memory instead. | |
503 */ | |
504 #define SDL_AllocSurface SDL_CreateRGBSurface | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
505 extern DECLSPEC SDL_Surface * SDLCALL SDL_CreateRGBSurface |
0 | 506 (Uint32 flags, int width, int height, int depth, |
507 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
508 extern DECLSPEC SDL_Surface * SDLCALL SDL_CreateRGBSurfaceFrom(void *pixels, |
0 | 509 int width, int height, int depth, int pitch, |
510 Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask); | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
511 extern DECLSPEC void SDLCALL SDL_FreeSurface(SDL_Surface *surface); |
0 | 512 |
513 /* | |
514 * SDL_LockSurface() sets up a surface for directly accessing the pixels. | |
515 * Between calls to SDL_LockSurface()/SDL_UnlockSurface(), you can write | |
516 * to and read from 'surface->pixels', using the pixel format stored in | |
517 * 'surface->format'. Once you are done accessing the surface, you should | |
518 * use SDL_UnlockSurface() to release it. | |
519 * | |
520 * Not all surfaces require locking. If SDL_MUSTLOCK(surface) evaluates | |
521 * to 0, then you can read and write to the surface at any time, and the | |
522 * pixel format of the surface will not change. In particular, if the | |
523 * SDL_HWSURFACE flag is not given when calling SDL_SetVideoMode(), you | |
524 * will not need to lock the display surface before accessing it. | |
525 * | |
526 * No operating system or library calls should be made between lock/unlock | |
527 * pairs, as critical system locks may be held during this time. | |
528 * | |
529 * SDL_LockSurface() returns 0, or -1 if the surface couldn't be locked. | |
530 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
531 extern DECLSPEC int SDLCALL SDL_LockSurface(SDL_Surface *surface); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
532 extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface); |
0 | 533 |
534 /* | |
535 * Load a surface from a seekable SDL data source (memory or file.) | |
536 * If 'freesrc' is non-zero, the source will be closed after being read. | |
537 * Returns the new surface, or NULL if there was an error. | |
538 * The new surface should be freed with SDL_FreeSurface(). | |
539 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
540 extern DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP_RW(SDL_RWops *src, int freesrc); |
0 | 541 |
542 /* Convenience macro -- load a surface from a file */ | |
543 #define SDL_LoadBMP(file) SDL_LoadBMP_RW(SDL_RWFromFile(file, "rb"), 1) | |
544 | |
545 /* | |
546 * Save a surface to a seekable SDL data source (memory or file.) | |
547 * If 'freedst' is non-zero, the source will be closed after being written. | |
548 * Returns 0 if successful or -1 if there was an error. | |
549 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
550 extern DECLSPEC int SDLCALL SDL_SaveBMP_RW |
0 | 551 (SDL_Surface *surface, SDL_RWops *dst, int freedst); |
552 | |
553 /* Convenience macro -- save a surface to a file */ | |
554 #define SDL_SaveBMP(surface, file) \ | |
555 SDL_SaveBMP_RW(surface, SDL_RWFromFile(file, "wb"), 1) | |
556 | |
557 /* | |
558 * Sets the color key (transparent pixel) in a blittable surface. | |
559 * If 'flag' is SDL_SRCCOLORKEY (optionally OR'd with SDL_RLEACCEL), | |
560 * 'key' will be the transparent pixel in the source image of a blit. | |
561 * SDL_RLEACCEL requests RLE acceleration for the surface if present, | |
562 * and removes RLE acceleration if absent. | |
563 * If 'flag' is 0, this function clears any current color key. | |
564 * This function returns 0, or -1 if there was an error. | |
565 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
566 extern DECLSPEC int SDLCALL SDL_SetColorKey |
0 | 567 (SDL_Surface *surface, Uint32 flag, Uint32 key); |
568 | |
569 /* | |
570 * This function sets the alpha value for the entire surface, as opposed to | |
571 * using the alpha component of each pixel. This value measures the range | |
572 * of transparency of the surface, 0 being completely transparent to 255 | |
573 * being completely opaque. An 'alpha' value of 255 causes blits to be | |
574 * opaque, the source pixels copied to the destination (the default). Note | |
575 * that per-surface alpha can be combined with colorkey transparency. | |
576 * | |
577 * If 'flag' is 0, alpha blending is disabled for the surface. | |
578 * If 'flag' is SDL_SRCALPHA, alpha blending is enabled for the surface. | |
579 * OR:ing the flag with SDL_RLEACCEL requests RLE acceleration for the | |
580 * surface; if SDL_RLEACCEL is not specified, the RLE accel will be removed. | |
432
80a35d43a58f
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
431
diff
changeset
|
581 * |
80a35d43a58f
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
431
diff
changeset
|
582 * The 'alpha' parameter is ignored for surfaces that have an alpha channel. |
0 | 583 */ |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
584 extern DECLSPEC int SDLCALL SDL_SetAlpha(SDL_Surface *surface, Uint32 flag, Uint8 alpha); |
0 | 585 |
586 /* | |
587 * Sets the clipping rectangle for the destination surface in a blit. | |
588 * | |
589 * If the clip rectangle is NULL, clipping will be disabled. | |
590 * If the clip rectangle doesn't intersect the surface, the function will | |
591 * return SDL_FALSE and blits will be completely clipped. Otherwise the | |
592 * function returns SDL_TRUE and blits to the surface will be clipped to | |
593 * the intersection of the surface area and the clipping rectangle. | |
594 * | |
595 * Note that blits are automatically clipped to the edges of the source | |
596 * and destination surfaces. | |
597 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
598 extern DECLSPEC SDL_bool SDLCALL SDL_SetClipRect(SDL_Surface *surface, const SDL_Rect *rect); |
0 | 599 |
600 /* | |
601 * Gets the clipping rectangle for the destination surface in a blit. | |
602 * 'rect' must be a pointer to a valid rectangle which will be filled | |
603 * with the correct values. | |
604 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
605 extern DECLSPEC void SDLCALL SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect); |
0 | 606 |
607 /* | |
608 * Creates a new surface of the specified format, and then copies and maps | |
609 * the given surface to it so the blit of the converted surface will be as | |
610 * fast as possible. If this function fails, it returns NULL. | |
611 * | |
612 * The 'flags' parameter is passed to SDL_CreateRGBSurface() and has those | |
613 * semantics. You can also pass SDL_RLEACCEL in the flags parameter and | |
614 * SDL will try to RLE accelerate colorkey and alpha blits in the resulting | |
615 * surface. | |
616 * | |
617 * This function is used internally by SDL_DisplayFormat(). | |
618 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
619 extern DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurface |
0 | 620 (SDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags); |
621 | |
622 /* | |
623 * This performs a fast blit from the source surface to the destination | |
624 * surface. It assumes that the source and destination rectangles are | |
625 * the same size. If either 'srcrect' or 'dstrect' are NULL, the entire | |
626 * surface (src or dst) is copied. The final blit rectangles are saved | |
627 * in 'srcrect' and 'dstrect' after all clipping is performed. | |
628 * If the blit is successful, it returns 0, otherwise it returns -1. | |
629 * | |
630 * The blit function should not be called on a locked surface. | |
631 * | |
632 * The blit semantics for surfaces with and without alpha and colorkey | |
633 * are defined as follows: | |
634 * | |
635 * RGBA->RGB: | |
636 * SDL_SRCALPHA set: | |
637 * alpha-blend (using alpha-channel). | |
638 * SDL_SRCCOLORKEY ignored. | |
639 * SDL_SRCALPHA not set: | |
640 * copy RGB. | |
641 * if SDL_SRCCOLORKEY set, only copy the pixels matching the | |
642 * RGB values of the source colour key, ignoring alpha in the | |
643 * comparison. | |
644 * | |
645 * RGB->RGBA: | |
646 * SDL_SRCALPHA set: | |
647 * alpha-blend (using the source per-surface alpha value); | |
648 * set destination alpha to opaque. | |
649 * SDL_SRCALPHA not set: | |
431
41cadcba32e8
Fixed SDL_DisplayFormatAlpha() on RGB surfaces with alpha
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
650 * copy RGB, set destination alpha to source per-surface alpha value. |
0 | 651 * both: |
652 * if SDL_SRCCOLORKEY set, only copy the pixels matching the | |
653 * source colour key. | |
654 * | |
655 * RGBA->RGBA: | |
656 * SDL_SRCALPHA set: | |
657 * alpha-blend (using the source alpha channel) the RGB values; | |
658 * leave destination alpha untouched. [Note: is this correct?] | |
659 * SDL_SRCCOLORKEY ignored. | |
660 * SDL_SRCALPHA not set: | |
661 * copy all of RGBA to the destination. | |
662 * if SDL_SRCCOLORKEY set, only copy the pixels matching the | |
663 * RGB values of the source colour key, ignoring alpha in the | |
664 * comparison. | |
665 * | |
666 * RGB->RGB: | |
667 * SDL_SRCALPHA set: | |
668 * alpha-blend (using the source per-surface alpha value). | |
669 * SDL_SRCALPHA not set: | |
670 * copy RGB. | |
671 * both: | |
672 * if SDL_SRCCOLORKEY set, only copy the pixels matching the | |
673 * source colour key. | |
674 * | |
675 * If either of the surfaces were in video memory, and the blit returns -2, | |
676 * the video memory was lost, so it should be reloaded with artwork and | |
677 * re-blitted: | |
678 while ( SDL_BlitSurface(image, imgrect, screen, dstrect) == -2 ) { | |
679 while ( SDL_LockSurface(image) < 0 ) | |
680 Sleep(10); | |
681 -- Write image pixels to image->pixels -- | |
682 SDL_UnlockSurface(image); | |
683 } | |
684 * This happens under DirectX 5.0 when the system switches away from your | |
685 * fullscreen application. The lock will also fail until you have access | |
686 * to the video memory again. | |
687 */ | |
688 /* You should call SDL_BlitSurface() unless you know exactly how SDL | |
689 blitting works internally and how to use the other blit functions. | |
690 */ | |
691 #define SDL_BlitSurface SDL_UpperBlit | |
692 | |
693 /* This is the public blit function, SDL_BlitSurface(), and it performs | |
694 rectangle validation and clipping before passing it to SDL_LowerBlit() | |
695 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
696 extern DECLSPEC int SDLCALL SDL_UpperBlit |
0 | 697 (SDL_Surface *src, SDL_Rect *srcrect, |
698 SDL_Surface *dst, SDL_Rect *dstrect); | |
699 /* This is a semi-private blit function and it performs low-level surface | |
700 blitting only. | |
701 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
702 extern DECLSPEC int SDLCALL SDL_LowerBlit |
0 | 703 (SDL_Surface *src, SDL_Rect *srcrect, |
704 SDL_Surface *dst, SDL_Rect *dstrect); | |
705 | |
706 /* | |
707 * This function performs a fast fill of the given rectangle with 'color' | |
708 * The given rectangle is clipped to the destination surface clip area | |
709 * and the final fill rectangle is saved in the passed in pointer. | |
710 * If 'dstrect' is NULL, the whole surface will be filled with 'color' | |
711 * The color should be a pixel of the format used by the surface, and | |
712 * can be generated by the SDL_MapRGB() function. | |
713 * This function returns 0 on success, or -1 on error. | |
714 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
715 extern DECLSPEC int SDLCALL SDL_FillRect |
0 | 716 (SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color); |
717 | |
718 /* | |
719 * This function takes a surface and copies it to a new surface of the | |
720 * pixel format and colors of the video framebuffer, suitable for fast | |
721 * blitting onto the display surface. It calls SDL_ConvertSurface() | |
722 * | |
723 * If you want to take advantage of hardware colorkey or alpha blit | |
724 * acceleration, you should set the colorkey and alpha value before | |
725 * calling this function. | |
726 * | |
727 * If the conversion fails or runs out of memory, it returns NULL | |
728 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
729 extern DECLSPEC SDL_Surface * SDLCALL SDL_DisplayFormat(SDL_Surface *surface); |
0 | 730 |
731 /* | |
732 * This function takes a surface and copies it to a new surface of the | |
733 * pixel format and colors of the video framebuffer (if possible), | |
734 * suitable for fast alpha blitting onto the display surface. | |
735 * The new surface will always have an alpha channel. | |
736 * | |
737 * If you want to take advantage of hardware colorkey or alpha blit | |
738 * acceleration, you should set the colorkey and alpha value before | |
739 * calling this function. | |
740 * | |
741 * If the conversion fails or runs out of memory, it returns NULL | |
742 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
743 extern DECLSPEC SDL_Surface * SDLCALL SDL_DisplayFormatAlpha(SDL_Surface *surface); |
0 | 744 |
745 | |
746 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
747 /* YUV video surface overlay functions */ | |
748 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
749 | |
750 /* This function creates a video output overlay | |
751 Calling the returned surface an overlay is something of a misnomer because | |
752 the contents of the display surface underneath the area where the overlay | |
753 is shown is undefined - it may be overwritten with the converted YUV data. | |
754 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
755 extern DECLSPEC SDL_Overlay * SDLCALL SDL_CreateYUVOverlay(int width, int height, |
0 | 756 Uint32 format, SDL_Surface *display); |
757 | |
758 /* Lock an overlay for direct access, and unlock it when you are done */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
759 extern DECLSPEC int SDLCALL SDL_LockYUVOverlay(SDL_Overlay *overlay); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
760 extern DECLSPEC void SDLCALL SDL_UnlockYUVOverlay(SDL_Overlay *overlay); |
0 | 761 |
762 /* Blit a video overlay to the display surface. | |
763 The contents of the video surface underneath the blit destination are | |
764 not defined. | |
765 The width and height of the destination rectangle may be different from | |
766 that of the overlay, but currently only 2x scaling is supported. | |
767 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
768 extern DECLSPEC int SDLCALL SDL_DisplayYUVOverlay(SDL_Overlay *overlay, SDL_Rect *dstrect); |
0 | 769 |
770 /* Free a video overlay */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
771 extern DECLSPEC void SDLCALL SDL_FreeYUVOverlay(SDL_Overlay *overlay); |
0 | 772 |
773 | |
774 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
775 /* OpenGL support functions. */ | |
776 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
777 | |
778 /* | |
1490
8f3e602904d1
Dynamic OpenGL loading is the default now. :)
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
779 * Dynamically load an OpenGL library, or the default one if path is NULL |
0 | 780 * |
781 * If you do this, you need to retrieve all of the GL functions used in | |
782 * your program from the dynamic library using SDL_GL_GetProcAddress(). | |
783 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
784 extern DECLSPEC int SDLCALL SDL_GL_LoadLibrary(const char *path); |
0 | 785 |
786 /* | |
1490
8f3e602904d1
Dynamic OpenGL loading is the default now. :)
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
787 * Get the address of a GL function |
0 | 788 */ |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
789 extern DECLSPEC void * SDLCALL SDL_GL_GetProcAddress(const char* proc); |
0 | 790 |
791 /* | |
792 * Set an attribute of the OpenGL subsystem before intialization. | |
793 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
794 extern DECLSPEC int SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int value); |
0 | 795 |
796 /* | |
797 * Get an attribute of the OpenGL subsystem from the windowing | |
798 * interface, such as glX. This is of course different from getting | |
799 * the values from SDL's internal OpenGL subsystem, which only | |
800 * stores the values you request before initialization. | |
801 * | |
802 * Developers should track the values they pass into SDL_GL_SetAttribute | |
803 * themselves if they want to retrieve these values. | |
804 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
805 extern DECLSPEC int SDLCALL SDL_GL_GetAttribute(SDL_GLattr attr, int* value); |
0 | 806 |
807 /* | |
808 * Swap the OpenGL buffers, if double-buffering is supported. | |
809 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
810 extern DECLSPEC void SDLCALL SDL_GL_SwapBuffers(void); |
0 | 811 |
812 /* | |
813 * Internal functions that should not be called unless you have read | |
814 * and understood the source code for these functions. | |
815 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
816 extern DECLSPEC void SDLCALL SDL_GL_UpdateRects(int numrects, SDL_Rect* rects); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
817 extern DECLSPEC void SDLCALL SDL_GL_Lock(void); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
818 extern DECLSPEC void SDLCALL SDL_GL_Unlock(void); |
0 | 819 |
820 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
821 /* These functions allow interaction with the window manager, if any. */ | |
822 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
823 | |
824 /* | |
1505 | 825 * Sets/Gets the title and icon text of the display window (UTF-8 encoded) |
0 | 826 */ |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
827 extern DECLSPEC void SDLCALL SDL_WM_SetCaption(const char *title, const char *icon); |
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
828 extern DECLSPEC void SDLCALL SDL_WM_GetCaption(char **title, char **icon); |
0 | 829 |
830 /* | |
831 * Sets the icon for the display window. | |
832 * This function must be called before the first call to SDL_SetVideoMode(). | |
833 * It takes an icon surface, and a mask in MSB format. | |
834 * If 'mask' is NULL, the entire icon surface will be used as the icon. | |
835 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
836 extern DECLSPEC void SDLCALL SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask); |
0 | 837 |
838 /* | |
839 * This function iconifies the window, and returns 1 if it succeeded. | |
840 * If the function succeeds, it generates an SDL_APPACTIVE loss event. | |
841 * This function is a noop and returns 0 in non-windowed environments. | |
842 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
843 extern DECLSPEC int SDLCALL SDL_WM_IconifyWindow(void); |
0 | 844 |
845 /* | |
846 * Toggle fullscreen mode without changing the contents of the screen. | |
847 * If the display surface does not require locking before accessing | |
848 * the pixel information, then the memory pointers will not change. | |
849 * | |
850 * If this function was able to toggle fullscreen mode (change from | |
851 * running in a window to fullscreen, or vice-versa), it will return 1. | |
852 * If it is not implemented, or fails, it returns 0. | |
853 * | |
854 * The next call to SDL_SetVideoMode() will set the mode fullscreen | |
855 * attribute based on the flags parameter - if SDL_FULLSCREEN is not | |
856 * set, then the display will be windowed by default where supported. | |
857 * | |
858 * This is currently only implemented in the X11 video driver. | |
859 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
860 extern DECLSPEC int SDLCALL SDL_WM_ToggleFullScreen(SDL_Surface *surface); |
0 | 861 |
862 /* | |
863 * This function allows you to set and query the input grab state of | |
864 * the application. It returns the new input grab state. | |
865 */ | |
866 typedef enum { | |
867 SDL_GRAB_QUERY = -1, | |
868 SDL_GRAB_OFF = 0, | |
869 SDL_GRAB_ON = 1, | |
870 SDL_GRAB_FULLSCREEN /* Used internally */ | |
871 } SDL_GrabMode; | |
872 /* | |
873 * Grabbing means that the mouse is confined to the application window, | |
874 * and nearly all keyboard input is passed directly to the application, | |
875 * and not interpreted by a window manager, if any. | |
876 */ | |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
877 extern DECLSPEC SDL_GrabMode SDLCALL SDL_WM_GrabInput(SDL_GrabMode mode); |
0 | 878 |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
879 /* Not in public API at the moment - do not use! */ |
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
880 extern DECLSPEC int SDLCALL SDL_SoftStretch(SDL_Surface *src, SDL_Rect *srcrect, |
47
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
881 SDL_Surface *dst, SDL_Rect *dstrect); |
45b1c4303f87
Added initial support for Quartz video (thanks Darrell!)
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
882 |
0 | 883 /* Ends C function definitions when using C++ */ |
884 #ifdef __cplusplus | |
885 } | |
886 #endif | |
887 #include "close_code.h" | |
888 | |
889 #endif /* _SDL_video_h */ |