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