• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_WM_SetIcon</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Window Management"
14HREF="wm.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_WM_GetCaption"
17HREF="sdlwmgetcaption.html"><LINK
18REL="NEXT"
19TITLE="SDL_WM_IconifyWindow"
20HREF="sdlwmiconifywindow.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlwmgetcaption.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlwmiconifywindow.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLWMSETICON"
74></A
75>SDL_WM_SetIcon</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN3582"
80></A
81><H2
82>Name</H2
83>SDL_WM_SetIcon&nbsp;--&nbsp;Sets the icon for the display window.</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN3585"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN3586"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>void <B
106CLASS="FSFUNC"
107>SDL_WM_SetIcon</B
108></CODE
109>(SDL_Surface *icon, Uint8 *mask);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN3592"
119></A
120><H2
121>Description</H2
122><P
123>Sets the icon for the display window. Win32 icons must be 32x32.</P
124><P
125>This function must be called before the first call to
126<A
127HREF="sdlsetvideomode.html"
128>SDL_SetVideoMode</A
129>.</P
130><P
131>The <TT
132CLASS="PARAMETER"
133><I
134>mask</I
135></TT
136> is a bitmask that describes the shape of the
137icon. If <TT
138CLASS="PARAMETER"
139><I
140>mask</I
141></TT
142> is NULL, then the shape is determined by
143the colorkey of <TT
144CLASS="PARAMETER"
145><I
146>icon</I
147></TT
148>, if any, or makes the icon
149rectangular (no transparency) otherwise.</P
150><P
151>If <TT
152CLASS="PARAMETER"
153><I
154>mask</I
155></TT
156> is non-NULL, it points to a bitmap with bits set
157where the corresponding pixel should be visible. The format of the bitmap is as
158follows: Scanlines come in the usual top-down order. Each scanline consists of
159(width / 8) bytes, rounded up. The most significant bit of each byte represents
160the leftmost pixel.</P
161></DIV
162><DIV
163CLASS="REFSECT1"
164><A
165NAME="AEN3603"
166></A
167><H2
168>Example</H2
169><PRE
170CLASS="PROGRAMLISTING"
171>SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE
172></DIV
173><DIV
174CLASS="REFSECT1"
175><A
176NAME="AEN3606"
177></A
178><H2
179>See Also</H2
180><P
181><A
182HREF="sdlsetvideomode.html"
183><TT
184CLASS="FUNCTION"
185>SDL_SetVideoMode</TT
186></A
187>,
188<A
189HREF="sdlwmsetcaption.html"
190><TT
191CLASS="FUNCTION"
192>SDL_WM_SetCaption</TT
193></A
194></P
195></DIV
196><DIV
197CLASS="NAVFOOTER"
198><HR
199ALIGN="LEFT"
200WIDTH="100%"><TABLE
201SUMMARY="Footer navigation table"
202WIDTH="100%"
203BORDER="0"
204CELLPADDING="0"
205CELLSPACING="0"
206><TR
207><TD
208WIDTH="33%"
209ALIGN="left"
210VALIGN="top"
211><A
212HREF="sdlwmgetcaption.html"
213ACCESSKEY="P"
214>Prev</A
215></TD
216><TD
217WIDTH="34%"
218ALIGN="center"
219VALIGN="top"
220><A
221HREF="index.html"
222ACCESSKEY="H"
223>Home</A
224></TD
225><TD
226WIDTH="33%"
227ALIGN="right"
228VALIGN="top"
229><A
230HREF="sdlwmiconifywindow.html"
231ACCESSKEY="N"
232>Next</A
233></TD
234></TR
235><TR
236><TD
237WIDTH="33%"
238ALIGN="left"
239VALIGN="top"
240>SDL_WM_GetCaption</TD
241><TD
242WIDTH="34%"
243ALIGN="center"
244VALIGN="top"
245><A
246HREF="wm.html"
247ACCESSKEY="U"
248>Up</A
249></TD
250><TD
251WIDTH="33%"
252ALIGN="right"
253VALIGN="top"
254>SDL_WM_IconifyWindow</TD
255></TR
256></TABLE
257></DIV
258></BODY
259></HTML
260>