Mercurial > sdl-ios-xcode

comparison docs/html/sdlwmseticon.html @ 803:355632dca928

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated SDL HTML documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 10 Feb 2004 15:15:40 +0000
parents e5bc29de3f0a
children
comparison
equal deleted inserted replaced
802:3c609d54f100 803:355632dca928
2 ><HEAD 2 ><HEAD
3 ><TITLE 3 ><TITLE
4 >SDL_WM_SetIcon</TITLE 4 >SDL_WM_SetIcon</TITLE
5 ><META 5 ><META
6 NAME="GENERATOR" 6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK 8 "><LINK
9 REL="HOME" 9 REL="HOME"
10 TITLE="SDL Library Documentation" 10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK 11 HREF="index.html"><LINK
12 REL="UP" 12 REL="UP"
26 VLINK="#551a8b" 26 VLINK="#551a8b"
27 ALINK="#ff0000" 27 ALINK="#ff0000"
28 ><DIV 28 ><DIV
29 CLASS="NAVHEADER" 29 CLASS="NAVHEADER"
30 ><TABLE 30 ><TABLE
31 SUMMARY="Header navigation table"
31 WIDTH="100%" 32 WIDTH="100%"
32 BORDER="0" 33 BORDER="0"
33 CELLPADDING="0" 34 CELLPADDING="0"
34 CELLSPACING="0" 35 CELLSPACING="0"
35 ><TR 36 ><TR
43 WIDTH="10%" 44 WIDTH="10%"
44 ALIGN="left" 45 ALIGN="left"
45 VALIGN="bottom" 46 VALIGN="bottom"
46 ><A 47 ><A
47 HREF="sdlwmgetcaption.html" 48 HREF="sdlwmgetcaption.html"
49 ACCESSKEY="P"
48 >Prev</A 50 >Prev</A
49 ></TD 51 ></TD
50 ><TD 52 ><TD
51 WIDTH="80%" 53 WIDTH="80%"
52 ALIGN="center" 54 ALIGN="center"
56 WIDTH="10%" 58 WIDTH="10%"
57 ALIGN="right" 59 ALIGN="right"
58 VALIGN="bottom" 60 VALIGN="bottom"
59 ><A 61 ><A
60 HREF="sdlwmiconifywindow.html" 62 HREF="sdlwmiconifywindow.html"
63 ACCESSKEY="N"
61 >Next</A 64 >Next</A
62 ></TD 65 ></TD
63 ></TR 66 ></TR
64 ></TABLE 67 ></TABLE
65 ><HR 68 ><HR
66 ALIGN="LEFT" 69 ALIGN="LEFT"
67 WIDTH="100%"></DIV 70 WIDTH="100%"></DIV
68 ><H1 71 ><H1
69 ><A 72 ><A
70 NAME="SDLWMSETICON" 73 NAME="SDLWMSETICON"
71 >SDL_WM_SetIcon</A 74 ></A
72 ></H1 75 >SDL_WM_SetIcon</H1
73 ><DIV 76 ><DIV
74 CLASS="REFNAMEDIV" 77 CLASS="REFNAMEDIV"
75 ><A 78 ><A
76 NAME="AEN3198" 79 NAME="AEN3582"
77 ></A 80 ></A
78 ><H2 81 ><H2
79 >Name</H2 82 >Name</H2
80 >SDL_WM_SetIcon&nbsp;--&nbsp;Sets the icon for the display window.</DIV 83 >SDL_WM_SetIcon&nbsp;--&nbsp;Sets the icon for the display window.</DIV
81 ><DIV 84 ><DIV
82 CLASS="REFSYNOPSISDIV" 85 CLASS="REFSYNOPSISDIV"
83 ><A 86 ><A
84 NAME="AEN3201" 87 NAME="AEN3585"
85 ></A 88 ></A
86 ><H2 89 ><H2
87 >Synopsis</H2 90 >Synopsis</H2
88 ><DIV 91 ><DIV
89 CLASS="FUNCSYNOPSIS" 92 CLASS="FUNCSYNOPSIS"
90 ><A 93 ><A
91 NAME="AEN3202" 94 NAME="AEN3586"
92 ></A 95 ></A
93 ><P 96 ><P
94 ></P 97 ></P
95 ><PRE 98 ><PRE
96 CLASS="FUNCSYNOPSISINFO" 99 CLASS="FUNCSYNOPSISINFO"
110 ></DIV 113 ></DIV
111 ></DIV 114 ></DIV
112 ><DIV 115 ><DIV
113 CLASS="REFSECT1" 116 CLASS="REFSECT1"
114 ><A 117 ><A
115 NAME="AEN3208" 118 NAME="AEN3592"
116 ></A 119 ></A
117 ><H2 120 ><H2
118 >Description</H2 121 >Description</H2
119 ><P 122 ><P
120 >Sets the icon for the display window. Win32 icons must be 32x32.</P 123 >Sets the icon for the display window. Win32 icons must be 32x32.</P
123 <A 126 <A
124 HREF="sdlsetvideomode.html" 127 HREF="sdlsetvideomode.html"
125 >SDL_SetVideoMode</A 128 >SDL_SetVideoMode</A
126 >.</P 129 >.</P
127 ><P 130 ><P
128 >It takes an <TT 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
129 CLASS="PARAMETER" 144 CLASS="PARAMETER"
130 ><I 145 ><I
131 >icon</I 146 >icon</I
132 ></TT 147 ></TT
133 > surface, and a <TT 148 >, if any, or makes the icon
149 rectangular (no transparency) otherwise.</P
150 ><P
151 >If <TT
134 CLASS="PARAMETER" 152 CLASS="PARAMETER"
135 ><I 153 ><I
136 >mask</I 154 >mask</I
137 ></TT 155 ></TT
138 > in MSB format.</P 156 > is non-NULL, it points to a bitmap with bits set
139 ><P 157 where the corresponding pixel should be visible. The format of the bitmap is as
140 >If <TT 158 follows: Scanlines come in the usual top-down order. Each scanline consists of
141 CLASS="PARAMETER" 159 (width / 8) bytes, rounded up. The most significant bit of each byte represents
142 ><I 160 the leftmost pixel.</P
143 >mask</I
144 ></TT
145 > is <TT
146 CLASS="LITERAL"
147 >NULL</TT
148 >, the entire
149 icon surface will be used as the icon.</P
150 ></DIV 161 ></DIV
151 ><DIV 162 ><DIV
152 CLASS="REFSECT1" 163 CLASS="REFSECT1"
153 ><A 164 ><A
154 NAME="AEN3219" 165 NAME="AEN3603"
155 ></A 166 ></A
156 ><H2 167 ><H2
157 >Example</H2 168 >Example</H2
158 ><PRE 169 ><PRE
159 CLASS="PROGRAMLISTING" 170 CLASS="PROGRAMLISTING"
160 >SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE 171 >SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE
161 ></DIV 172 ></DIV
162 ><DIV 173 ><DIV
163 CLASS="REFSECT1" 174 CLASS="REFSECT1"
164 ><A 175 ><A
165 NAME="AEN3222" 176 NAME="AEN3606"
166 ></A 177 ></A
167 ><H2 178 ><H2
168 >See Also</H2 179 >See Also</H2
169 ><P 180 ><P
170 ><A 181 ><A
185 ><DIV 196 ><DIV
186 CLASS="NAVFOOTER" 197 CLASS="NAVFOOTER"
187 ><HR 198 ><HR
188 ALIGN="LEFT" 199 ALIGN="LEFT"
189 WIDTH="100%"><TABLE 200 WIDTH="100%"><TABLE
201 SUMMARY="Footer navigation table"
190 WIDTH="100%" 202 WIDTH="100%"
191 BORDER="0" 203 BORDER="0"
192 CELLPADDING="0" 204 CELLPADDING="0"
193 CELLSPACING="0" 205 CELLSPACING="0"
194 ><TR 206 ><TR
196 WIDTH="33%" 208 WIDTH="33%"
197 ALIGN="left" 209 ALIGN="left"
198 VALIGN="top" 210 VALIGN="top"
199 ><A 211 ><A
200 HREF="sdlwmgetcaption.html" 212 HREF="sdlwmgetcaption.html"
213 ACCESSKEY="P"
201 >Prev</A 214 >Prev</A
202 ></TD 215 ></TD
203 ><TD 216 ><TD
204 WIDTH="34%" 217 WIDTH="34%"
205 ALIGN="center" 218 ALIGN="center"
206 VALIGN="top" 219 VALIGN="top"
207 ><A 220 ><A
208 HREF="index.html" 221 HREF="index.html"
222 ACCESSKEY="H"
209 >Home</A 223 >Home</A
210 ></TD 224 ></TD
211 ><TD 225 ><TD
212 WIDTH="33%" 226 WIDTH="33%"
213 ALIGN="right" 227 ALIGN="right"
214 VALIGN="top" 228 VALIGN="top"
215 ><A 229 ><A
216 HREF="sdlwmiconifywindow.html" 230 HREF="sdlwmiconifywindow.html"
231 ACCESSKEY="N"
217 >Next</A 232 >Next</A
218 ></TD 233 ></TD
219 ></TR 234 ></TR
220 ><TR 235 ><TR
221 ><TD 236 ><TD
227 WIDTH="34%" 242 WIDTH="34%"
228 ALIGN="center" 243 ALIGN="center"
229 VALIGN="top" 244 VALIGN="top"
230 ><A 245 ><A
231 HREF="wm.html" 246 HREF="wm.html"
247 ACCESSKEY="U"
232 >Up</A 248 >Up</A
233 ></TD 249 ></TD
234 ><TD 250 ><TD
235 WIDTH="33%" 251 WIDTH="33%"
236 ALIGN="right" 252 ALIGN="right"