home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue2 / SDL.ARC / sdlhtmldox / sdlwmsetic < prev    next >
Encoding:
Text File  |  2001-05-09  |  3.0 KB  |  244 lines
  1. <HTML
  2. ><HEAD
  3. ><TITLE
  4. >SDL_WM_SetIcon</TITLE
  5. ><META
  6. NAME="GENERATOR"
  7. CONTENT="Modular DocBook HTML Stylesheet Version 1.64
  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. WIDTH="100%"
  32. BORDER="0"
  33. CELLPADDING="0"
  34. CELLSPACING="0"
  35. ><TR
  36. ><TH
  37. COLSPAN="3"
  38. ALIGN="center"
  39. >SDL Library Documentation</TH
  40. ></TR
  41. ><TR
  42. ><TD
  43. WIDTH="10%"
  44. ALIGN="left"
  45. VALIGN="bottom"
  46. ><A
  47. HREF="sdlwmgetcaption.html"
  48. >Prev</A
  49. ></TD
  50. ><TD
  51. WIDTH="80%"
  52. ALIGN="center"
  53. VALIGN="bottom"
  54. ></TD
  55. ><TD
  56. WIDTH="10%"
  57. ALIGN="right"
  58. VALIGN="bottom"
  59. ><A
  60. HREF="sdlwmiconifywindow.html"
  61. >Next</A
  62. ></TD
  63. ></TR
  64. ></TABLE
  65. ><HR
  66. ALIGN="LEFT"
  67. WIDTH="100%"></DIV
  68. ><H1
  69. ><A
  70. NAME="SDLWMSETICON"
  71. >SDL_WM_SetIcon</A
  72. ></H1
  73. ><DIV
  74. CLASS="REFNAMEDIV"
  75. ><A
  76. NAME="AEN3166"
  77. ></A
  78. ><H2
  79. >Name</H2
  80. >SDL_WM_SetIcon -- Sets the icon for the display window.</DIV
  81. ><DIV
  82. CLASS="REFSYNOPSISDIV"
  83. ><A
  84. NAME="AEN3169"
  85. ></A
  86. ><H2
  87. >Synopsis</H2
  88. ><DIV
  89. CLASS="FUNCSYNOPSIS"
  90. ><A
  91. NAME="AEN3170"
  92. ></A
  93. ><P
  94. ></P
  95. ><PRE
  96. CLASS="FUNCSYNOPSISINFO"
  97. >#include "SDL.h"</PRE
  98. ><P
  99. ><CODE
  100. ><CODE
  101. CLASS="FUNCDEF"
  102. >void <B
  103. CLASS="FSFUNC"
  104. >SDL_WM_SetIcon</B
  105. ></CODE
  106. >(SDL_Surface *icon, Uint8 *mask);</CODE
  107. ></P
  108. ><P
  109. ></P
  110. ></DIV
  111. ></DIV
  112. ><DIV
  113. CLASS="REFSECT1"
  114. ><A
  115. NAME="AEN3176"
  116. ></A
  117. ><H2
  118. >Description</H2
  119. ><P
  120. >Sets the icon for the display window.</P
  121. ><P
  122. >This function must be called before the first call to 
  123. <A
  124. HREF="sdlsetvideomode.html"
  125. >SDL_SetVideoMode</A
  126. >.</P
  127. ><P
  128. >It takes an <TT
  129. CLASS="PARAMETER"
  130. ><I
  131. >icon</I
  132. ></TT
  133. > surface, and a <TT
  134. CLASS="PARAMETER"
  135. ><I
  136. >mask</I
  137. ></TT
  138. > in MSB format.</P
  139. ><P
  140. >If <TT
  141. CLASS="PARAMETER"
  142. ><I
  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
  151. ><DIV
  152. CLASS="REFSECT1"
  153. ><A
  154. NAME="AEN3187"
  155. ></A
  156. ><H2
  157. >Example</H2
  158. ><PRE
  159. CLASS="PROGRAMLISTING"
  160. >SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE
  161. ></DIV
  162. ><DIV
  163. CLASS="REFSECT1"
  164. ><A
  165. NAME="AEN3190"
  166. ></A
  167. ><H2
  168. >See Also</H2
  169. ><P
  170. ><A
  171. HREF="sdlsetvideomode.html"
  172. ><TT
  173. CLASS="FUNCTION"
  174. >SDL_SetVideoMode</TT
  175. ></A
  176. >,
  177. <A
  178. HREF="sdlwmsetcaption.html"
  179. ><TT
  180. CLASS="FUNCTION"
  181. >SDL_WM_SetCaption</TT
  182. ></A
  183. ></P
  184. ></DIV
  185. ><DIV
  186. CLASS="NAVFOOTER"
  187. ><HR
  188. ALIGN="LEFT"
  189. WIDTH="100%"><TABLE
  190. WIDTH="100%"
  191. BORDER="0"
  192. CELLPADDING="0"
  193. CELLSPACING="0"
  194. ><TR
  195. ><TD
  196. WIDTH="33%"
  197. ALIGN="left"
  198. VALIGN="top"
  199. ><A
  200. HREF="sdlwmgetcaption.html"
  201. >Prev</A
  202. ></TD
  203. ><TD
  204. WIDTH="34%"
  205. ALIGN="center"
  206. VALIGN="top"
  207. ><A
  208. HREF="index.html"
  209. >Home</A
  210. ></TD
  211. ><TD
  212. WIDTH="33%"
  213. ALIGN="right"
  214. VALIGN="top"
  215. ><A
  216. HREF="sdlwmiconifywindow.html"
  217. >Next</A
  218. ></TD
  219. ></TR
  220. ><TR
  221. ><TD
  222. WIDTH="33%"
  223. ALIGN="left"
  224. VALIGN="top"
  225. >SDL_WM_GetCaption</TD
  226. ><TD
  227. WIDTH="34%"
  228. ALIGN="center"
  229. VALIGN="top"
  230. ><A
  231. HREF="wm.html"
  232. >Up</A
  233. ></TD
  234. ><TD
  235. WIDTH="33%"
  236. ALIGN="right"
  237. VALIGN="top"
  238. >SDL_WM_IconifyWindow</TD
  239. ></TR
  240. ></TABLE
  241. ></DIV
  242. ></BODY
  243. ></HTML
  244. >