1SDL_Overlay(3)                 SDL API Reference                SDL_Overlay(3)
2
3
4

NAME

6       SDL_Overlay - YUV video overlay
7

STRUCTURE DEFINITION

9       typedef struct{
10         Uint32 format;
11         int w, h;
12         int planes;
13         Uint16 *pitches;
14         Uint8 **pixels;
15         Uint32 hw_overlay:1;
16       } SDL_Overlay;
17

STRUCTURE DATA

19       format              Overlay format (see below)
20
21       w, h                Width and height of overlay
22
23       planes              Number  of  planes in the overlay. Usually either 1
24                           or 3
25
26       pitches             An array of pitches, one for each plane.  Pitch  is
27                           the length of a row in bytes.
28
29       pixels              An array of pointers to teh data of each plane. The
30                           overlay should be locked before these pointers  are
31                           used.
32
33       hw_overlay          This  will  be  set to 1 if the overlay is hardware
34                           accelerated.
35

DESCRIPTION

37       A SDL_Overlay is similar to a SDL_Surface except it stores a YUV  over‐
38       lay.  All  the  fields are read only, except for pixels which should be
39       locked before use. The format field stores the format  of  the  overlay
40       which is one of the following:
41
42       #define SDL_YV12_OVERLAY  0x32315659  /* Planar mode: Y + V + U */
43       #define SDL_IYUV_OVERLAY  0x56555949  /* Planar mode: Y + U + V */
44       #define SDL_YUY2_OVERLAY  0x32595559  /* Packed mode: Y0+U0+Y1+V0 */
45       #define SDL_UYVY_OVERLAY  0x59565955  /* Packed mode: U0+Y0+V0+Y1 */
46       #define SDL_YVYU_OVERLAY  0x55595659  /* Packed mode: Y0+V0+Y1+U0 */
47
48        More    information    on    YUV    formats    can    be    found   at
49       http://www.webartz.com/fourcc/indexyuv.htm      (link      to       URL
50       http://www.webartz.com/fourcc/indexyuv.htm) .
51

SEE ALSO

53       SDL_CreateYUVOverlay,     SDL_LockYUVOverlay,     SDL_UnlockYUVOverlay,
54       SDL_FreeYUVOverlay
55
56
57
58SDL                         Tue 11 Sep 2001, 23:01              SDL_Overlay(3)
Impressum