[sdl_omap.git] / docs / man3 / SDL_WM_SetIcon.3

.TH "SDL_WM_SetIcon" "3" "Tue 11 Sep 2001, 23:02" "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\&. Win32 icons must be 32x32\&.
.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, Tue 11 Sep 2001, 23:02
Commit	Line	Data
e14743d1	1	.TH "SDL_WM_SetIcon" "3" "Tue 11 Sep 2001, 23:02" "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\&. Win32 icons must be 32x32\&.
	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, Tue 11 Sep 2001, 23:02