docs/man3/SDL_Overlay.3
author Sam Lantinga <slouken@libsdl.org>
Sat, 29 Dec 2007 03:25:11 +0000
changeset 2283 546f7c1eb755
parent 181 e5bc29de3f0a
child 4311 1238da4a7112
permissions -rw-r--r--
Merged revision 3472 from SDL 1.2, fixing bug #493
slouken@181
     1
.TH "SDL_Overlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@2283
     3
SDL_Overlay \- YUV video overlay
slouken@0
     4
.SH "STRUCTURE DEFINITION"
slouken@0
     5
.PP
slouken@0
     6
.nf
slouken@0
     7
\f(CWtypedef struct{
slouken@0
     8
  Uint32 format;
slouken@0
     9
  int w, h;
slouken@0
    10
  int planes;
slouken@0
    11
  Uint16 *pitches;
slouken@0
    12
  Uint8 **pixels;
slouken@0
    13
  Uint32 hw_overlay:1;
slouken@0
    14
} SDL_Overlay;\fR
slouken@0
    15
.fi
slouken@0
    16
.PP
slouken@0
    17
.SH "STRUCTURE DATA"
slouken@0
    18
.TP 20
slouken@0
    19
\fBformat\fR
slouken@0
    20
Overlay format (see below)
slouken@0
    21
.TP 20
slouken@0
    22
\fBw, h\fR
slouken@0
    23
Width and height of overlay
slouken@0
    24
.TP 20
slouken@0
    25
\fBplanes\fR
slouken@0
    26
Number of planes in the overlay\&. Usually either 1 or 3
slouken@0
    27
.TP 20
slouken@0
    28
\fBpitches\fR
slouken@0
    29
An array of pitches, one for each plane\&. Pitch is the length of a row in bytes\&.
slouken@0
    30
.TP 20
slouken@0
    31
\fBpixels\fR
slouken@0
    32
An array of pointers to teh data of each plane\&. The overlay should be locked before these pointers are used\&.
slouken@0
    33
.TP 20
slouken@0
    34
\fBhw_overlay\fR
slouken@0
    35
This will be set to 1 if the overlay is hardware accelerated\&.
slouken@0
    36
.SH "DESCRIPTION"
slouken@0
    37
.PP
slouken@0
    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: 
slouken@0
    39
.PP
slouken@0
    40
.nf
slouken@0
    41
\f(CW#define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
slouken@0
    42
#define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
slouken@0
    43
#define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
slouken@0
    44
#define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
slouken@0
    45
#define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */\fR
slouken@0
    46
.fi
slouken@0
    47
.PP
slouken@0
    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\&.
slouken@0
    49
.SH "SEE ALSO"
slouken@0
    50
.PP
slouken@0
    51
\fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_LockYUVOverlay\fP\fR, \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR
slouken@181
    52
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01