docs/man3/SDL_Surface.3
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/man3/SDL_Surface.3	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,96 +0,0 @@
     1.4 -.TH "SDL_Surface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
     1.5 -.SH "NAME"
     1.6 -SDL_Surface \- Graphical Surface Structure
     1.7 -.SH "STRUCTURE DEFINITION"
     1.8 -.PP
     1.9 -.nf
    1.10 -\f(CWtypedef struct SDL_Surface {
    1.11 -        Uint32 flags;                           /* Read-only */
    1.12 -        SDL_PixelFormat *format;                /* Read-only */
    1.13 -        int w, h;                               /* Read-only */
    1.14 -        Uint16 pitch;                           /* Read-only */
    1.15 -        void *pixels;                           /* Read-write */
    1.16 -
    1.17 -        /* clipping information */
    1.18 -        SDL_Rect clip_rect;                     /* Read-only */
    1.19 -
    1.20 -        /* Reference count -- used when freeing surface */
    1.21 -        int refcount;                           /* Read-mostly */
    1.22 -
    1.23 -	/* This structure also contains private fields not shown here */
    1.24 -} SDL_Surface;\fR
    1.25 -.fi
    1.26 -.PP
    1.27 -.SH "STRUCTURE DATA"
    1.28 -.TP 20
    1.29 -\fBflags\fR
    1.30 -Surface flags
    1.31 -.TP 20
    1.32 -\fBformat\fR
    1.33 -Pixel \fIformat\fR
    1.34 -.TP 20
    1.35 -\fBw, h\fR
    1.36 -Width and height of the surface
    1.37 -.TP 20
    1.38 -\fBpitch\fR
    1.39 -Length of a surface scanline in bytes
    1.40 -.TP 20
    1.41 -\fBpixels\fR
    1.42 -Pointer to the actual pixel data
    1.43 -.TP 20
    1.44 -\fBclip_rect\fR
    1.45 -surface clip \fIrectangle\fR
    1.46 -.SH "DESCRIPTION"
    1.47 -.PP
    1.48 -\fBSDL_Surface\fR\&'s represent areas of "graphical" memory, memory that can be drawn to\&. The video framebuffer is returned as a \fBSDL_Surface\fR by \fI\fBSDL_SetVideoMode\fP\fR and \fI\fBSDL_GetVideoSurface\fP\fR\&. Most of the fields should be pretty obvious\&. \fBw\fR and \fBh\fR are the width and height of the surface in pixels\&. \fBpixels\fR is a pointer to the actual pixel data, the surface should be \fIlocked\fR before accessing this field\&. The \fBclip_rect\fR field is the clipping rectangle as set by \fI\fBSDL_SetClipRect\fP\fR\&.
    1.49 -.PP
    1.50 -The following are supported in the \fBflags\fR field\&.
    1.51 -.TP 20
    1.52 -\fBSDL_SWSURFACE\fP
    1.53 -Surface is stored in system memory
    1.54 -.TP 20
    1.55 -\fBSDL_HWSURFACE\fP
    1.56 -Surface is stored in video memory
    1.57 -.TP 20
    1.58 -\fBSDL_ASYNCBLIT\fP
    1.59 -Surface uses asynchronous blits if possible
    1.60 -.TP 20
    1.61 -\fBSDL_ANYFORMAT\fP
    1.62 -Allows any pixel-format (Display surface)
    1.63 -.TP 20
    1.64 -\fBSDL_HWPALETTE\fP
    1.65 -Surface has exclusive palette
    1.66 -.TP 20
    1.67 -\fBSDL_DOUBLEBUF\fP
    1.68 -Surface is double buffered (Display surface)
    1.69 -.TP 20
    1.70 -\fBSDL_FULLSCREEN\fP
    1.71 -Surface is full screen (Display Surface)
    1.72 -.TP 20
    1.73 -\fBSDL_OPENGL\fP
    1.74 -Surface has an OpenGL context (Display Surface)
    1.75 -.TP 20
    1.76 -\fBSDL_OPENGLBLIT\fP
    1.77 -Surface supports OpenGL blitting (Display Surface)
    1.78 -.TP 20
    1.79 -\fBSDL_RESIZABLE\fP
    1.80 -Surface is resizable (Display Surface)
    1.81 -.TP 20
    1.82 -\fBSDL_HWACCEL\fP
    1.83 -Surface blit uses hardware acceleration
    1.84 -.TP 20
    1.85 -\fBSDL_SRCCOLORKEY\fP
    1.86 -Surface use colorkey blitting
    1.87 -.TP 20
    1.88 -\fBSDL_RLEACCEL\fP
    1.89 -Colorkey blitting is accelerated with RLE
    1.90 -.TP 20
    1.91 -\fBSDL_SRCALPHA\fP
    1.92 -Surface blit uses alpha blending
    1.93 -.TP 20
    1.94 -\fBSDL_PREALLOC\fP
    1.95 -Surface uses preallocated memory
    1.96 -.SH "SEE ALSO"
    1.97 -.PP
    1.98 -\fI\fBSDL_PixelFormat\fR\fR
    1.99 -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01