Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_Surface.3 @ 55:55f1f1b3e27d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added new docs for SDL 1.2.1
author Sam Lantinga <slouken@lokigames.com>
date Sun, 10 Jun 2001 19:31:57 +0000
parents 74212992fb08
children e5bc29de3f0a
comparison
equal deleted inserted replaced
54:028447a8a758 55:55f1f1b3e27d
1 .TH "SDL_Surface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 1 .TH "SDL_Surface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_Surface\- Graphical Surface Structure 3 SDL_Surface\- Graphical Surface Structure
4 .SH "STRUCTURE DEFINITION" 4 .SH "STRUCTURE DEFINITION"
5 .PP 5 .PP
6 .nf 6 .nf
8 Uint32 flags; /* Read-only */ 8 Uint32 flags; /* Read-only */
9 SDL_PixelFormat *format; /* Read-only */ 9 SDL_PixelFormat *format; /* Read-only */
10 int w, h; /* Read-only */ 10 int w, h; /* Read-only */
11 Uint16 pitch; /* Read-only */ 11 Uint16 pitch; /* Read-only */
12 void *pixels; /* Read-write */ 12 void *pixels; /* Read-write */
13 int offset; /* Private */
14
15 /* Hardware-specific surface info */
16 struct private_hwdata *hwdata;
17 13
18 /* clipping information */ 14 /* clipping information */
19 SDL_Rect clip_rect; /* Read-only */ 15 SDL_Rect clip_rect; /* Read-only */
20 Uint32 unused1; /* for binary compatibility */
21 Uint32 unused2; /* for binary compatibility */
22
23 /* info for fast blit mapping to other surfaces */
24 struct SDL_BlitMap *map; /* Private */
25
26 /* format version, bumped at every change to invalidate blit maps */
27 unsigned int format_version; /* Private */
28 16
29 /* Reference count -- used when freeing surface */ 17 /* Reference count -- used when freeing surface */
30 int refcount; /* Read-mostly */ 18 int refcount; /* Read-mostly */
19
20 /* This structure also contains private fields not shown here */
31 } SDL_Surface;\fR 21 } SDL_Surface;\fR
32 .fi 22 .fi
33 .PP 23 .PP
34 .SH "STRUCTURE DATA" 24 .SH "STRUCTURE DATA"
35 .TP 20 25 .TP 20
45 \fBpitch\fR 35 \fBpitch\fR
46 Length of a surface scanline in bytes 36 Length of a surface scanline in bytes
47 .TP 20 37 .TP 20
48 \fBpixels\fR 38 \fBpixels\fR
49 Pointer to the actual pixel data 39 Pointer to the actual pixel data
50 .TP 20
51 \fBclip_minx, clip_maxx\fR
52 X clip coords
53 .TP 20 40 .TP 20
54 \fBclip_rect\fR 41 \fBclip_rect\fR
55 surface clip \fIrectangle\fR 42 surface clip \fIrectangle\fR
56 .SH "DESCRIPTION" 43 .SH "DESCRIPTION"
57 .PP 44 .PP
90 Surface is resizable (Display Surface) 77 Surface is resizable (Display Surface)
91 .TP 20 78 .TP 20
92 \fBSDL_HWACCEL\fP 79 \fBSDL_HWACCEL\fP
93 Surface blit uses hardware acceleration 80 Surface blit uses hardware acceleration
94 .TP 20 81 .TP 20
95 \fBSDL_SRCOLORKEY\fP 82 \fBSDL_SRCCOLORKEY\fP
96 Surface use colorkey blitting 83 Surface use colorkey blitting
97 .TP 20 84 .TP 20
98 \fBSDL_RLEACCEL\fP 85 \fBSDL_RLEACCEL\fP
99 Colorkey blitting is accelerated with RLE 86 Colorkey blitting is accelerated with RLE
100 .TP 20 87 .TP 20
104 \fBSDL_PREALLOC\fP 91 \fBSDL_PREALLOC\fP
105 Surface uses preallocated memory 92 Surface uses preallocated memory
106 .SH "SEE ALSO" 93 .SH "SEE ALSO"
107 .PP 94 .PP
108 \fI\fBSDL_PixelFormat\fR\fR 95 \fI\fBSDL_PixelFormat\fR\fR
109 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 96 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42