Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_Overlay.3 @ 1625:7e89aa7843c5
Fixed bug #193
The attached patch is mostly cosmetic: Currently, we always add both -framework
OpenGL and -framework AGL for Mac OS X command line builds.
However, the former is only used for the Cocoa video driver, and the latter
only for the Carbon video driver (as far as I can tell, at least). Hence the
attached patch modifies configure.in so that each only gets added to the list
of frameworks if the corresponding video driver is enabled.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Thu, 13 Apr 2006 13:30:21 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_Overlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
| 3 SDL_Overlay\- YUV video overlay | |
| 4 .SH "STRUCTURE DEFINITION" | |
| 5 .PP | |
| 6 .nf | |
| 7 \f(CWtypedef struct{ | |
| 8 Uint32 format; | |
| 9 int w, h; | |
| 10 int planes; | |
| 11 Uint16 *pitches; | |
| 12 Uint8 **pixels; | |
| 13 Uint32 hw_overlay:1; | |
| 14 } SDL_Overlay;\fR | |
| 15 .fi | |
| 16 .PP | |
| 17 .SH "STRUCTURE DATA" | |
| 18 .TP 20 | |
| 19 \fBformat\fR | |
| 20 Overlay format (see below) | |
| 21 .TP 20 | |
| 22 \fBw, h\fR | |
| 23 Width and height of overlay | |
| 24 .TP 20 | |
| 25 \fBplanes\fR | |
| 26 Number of planes in the overlay\&. Usually either 1 or 3 | |
| 27 .TP 20 | |
| 28 \fBpitches\fR | |
| 29 An array of pitches, one for each plane\&. Pitch is the length of a row in bytes\&. | |
| 30 .TP 20 | |
| 31 \fBpixels\fR | |
| 32 An array of pointers to teh data of each plane\&. The overlay should be locked before these pointers are used\&. | |
| 33 .TP 20 | |
| 34 \fBhw_overlay\fR | |
| 35 This will be set to 1 if the overlay is hardware accelerated\&. | |
| 36 .SH "DESCRIPTION" | |
| 37 .PP | |
| 38 A \fBSDL_Overlay\fR is similar to a \fI\fBSDL_Surface\fR\fR except it stores a YUV overlay\&. All the fields are read only, except for \fBpixels\fR which should be \fIlocked\fR before use\&. The \fBformat\fR field stores the format of the overlay which is one of the following: | |
| 39 .PP | |
| 40 .nf | |
| 41 \f(CW#define SDL_YV12_OVERLAY 0x32315659 /* Planar mode: Y + V + U */ | |
| 42 #define SDL_IYUV_OVERLAY 0x56555949 /* Planar mode: Y + U + V */ | |
| 43 #define SDL_YUY2_OVERLAY 0x32595559 /* Packed mode: Y0+U0+Y1+V0 */ | |
| 44 #define SDL_UYVY_OVERLAY 0x59565955 /* Packed mode: U0+Y0+V0+Y1 */ | |
| 45 #define SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */\fR | |
| 46 .fi | |
| 47 .PP | |
| 48 More information on YUV formats can be found at \fIhttp://www\&.webartz\&.com/fourcc/indexyuv\&.htm (link to URL http://www.webartz.com/fourcc/indexyuv.htm) \fR\&. | |
| 49 .SH "SEE ALSO" | |
| 50 .PP | |
| 51 \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_LockYUVOverlay\fP\fR, \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
52 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |