diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_WM_SetIcon.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,27 @@
+.TH "SDL_WM_SetIcon" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" 
+.SH "NAME"
+SDL_WM_SetIcon\- Sets the icon for the display window\&.
+.SH "SYNOPSIS"
+.PP
+\fB#include "SDL\&.h"
+.sp
+\fBvoid \fBSDL_WM_SetIcon\fP\fR(\fBSDL_Surface *icon, Uint8 *mask\fR);
+.SH "DESCRIPTION"
+.PP
+Sets the icon for the display window\&.
+.PP
+This function must be called before the first call to \fISDL_SetVideoMode\fR\&.
+.PP
+It takes an \fBicon\fR surface, and a \fBmask\fR in MSB format\&.
+.PP
+If \fBmask\fR is \fBNULL\fP, the entire icon surface will be used as the icon\&.
+.SH "EXAMPLE"
+.PP
+.nf
+\f(CWSDL_WM_SetIcon(SDL_LoadBMP("icon\&.bmp"), NULL);\fR
+.fi
+.PP
+.SH "SEE ALSO"
+.PP
+\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_WM_SetCaption\fP\fR
+...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05