Mercurial > sdl-ios-xcode
view docs/man3/SDL_Overlay.3 @ 779:68c8da837fc0
Date: Tue, 6 Jan 2004 21:54:02 +0100
From: Max Horn
Subject: Auto hide mouse & other changes
the attached bug adds the auto-hide-mouse feature I talked about
earlier. Turned out it was a lot simpler than I thought, simply by
using our existing code :-). I actually spent much more time on fixing
various bugs in the code and correcting (IMO) some behavior (although,
due to the lack of real specs for SDL, it's probably arguable what
'correct' means...).
* adds auto (un)hiding of mouse depending on whether it is in- or
outside the game window
* computation of course coordinates is correct now (it often and
reproducible got out of sync with the old code, since the NSEvent
window was in some cases *not* our window anymore, so locationInWindow
returned wrong results)
* added a method which at any time returns the mouse coords, relative
to our window
* fixed handling of lost/gain input/mouse/app focus "events"
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 07 Jan 2004 15:01:51 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
line wrap: on
line source
.TH "SDL_Overlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_Overlay\- YUV video overlay .SH "STRUCTURE DEFINITION" .PP .nf \f(CWtypedef struct{ Uint32 format; int w, h; int planes; Uint16 *pitches; Uint8 **pixels; Uint32 hw_overlay:1; } SDL_Overlay;\fR .fi .PP .SH "STRUCTURE DATA" .TP 20 \fBformat\fR Overlay format (see below) .TP 20 \fBw, h\fR Width and height of overlay .TP 20 \fBplanes\fR Number of planes in the overlay\&. Usually either 1 or 3 .TP 20 \fBpitches\fR An array of pitches, one for each plane\&. Pitch is the length of a row in bytes\&. .TP 20 \fBpixels\fR An array of pointers to teh data of each plane\&. The overlay should be locked before these pointers are used\&. .TP 20 \fBhw_overlay\fR This will be set to 1 if the overlay is hardware accelerated\&. .SH "DESCRIPTION" .PP 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: .PP .nf \f(CW#define SDL_YV12_OVERLAY 0x32315659 /* Planar mode: Y + V + U */ #define SDL_IYUV_OVERLAY 0x56555949 /* Planar mode: Y + U + V */ #define SDL_YUY2_OVERLAY 0x32595559 /* Packed mode: Y0+U0+Y1+V0 */ #define SDL_UYVY_OVERLAY 0x59565955 /* Packed mode: U0+Y0+V0+Y1 */ #define SDL_YVYU_OVERLAY 0x55595659 /* Packed mode: Y0+V0+Y1+U0 */\fR .fi .PP 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\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_LockYUVOverlay\fP\fR, \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01