Mercurial > sdl-ios-xcode
comparison docs/man3/SDL_WM_SetIcon.3 @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:74212992fb08 |
---|---|
1 .TH "SDL_WM_SetIcon" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" | |
2 .SH "NAME" | |
3 SDL_WM_SetIcon\- Sets the icon for the display window\&. | |
4 .SH "SYNOPSIS" | |
5 .PP | |
6 \fB#include "SDL\&.h" | |
7 .sp | |
8 \fBvoid \fBSDL_WM_SetIcon\fP\fR(\fBSDL_Surface *icon, Uint8 *mask\fR); | |
9 .SH "DESCRIPTION" | |
10 .PP | |
11 Sets the icon for the display window\&. | |
12 .PP | |
13 This function must be called before the first call to \fISDL_SetVideoMode\fR\&. | |
14 .PP | |
15 It takes an \fBicon\fR surface, and a \fBmask\fR in MSB format\&. | |
16 .PP | |
17 If \fBmask\fR is \fBNULL\fP, the entire icon surface will be used as the icon\&. | |
18 .SH "EXAMPLE" | |
19 .PP | |
20 .nf | |
21 \f(CWSDL_WM_SetIcon(SDL_LoadBMP("icon\&.bmp"), NULL);\fR | |
22 .fi | |
23 .PP | |
24 .SH "SEE ALSO" | |
25 .PP | |
26 \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_WM_SetCaption\fP\fR | |
27 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 |