Mercurial > sdl-ios-xcode
view docs/html/sdlwmseticon.html @ 1:cf2af46e9e2a
Changes since SDL 1.2.0 release
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:50:19 +0000 |
parents | 74212992fb08 |
children | 55f1f1b3e27d |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_WM_SetIcon</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.61 "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Window Management" HREF="wm.html"><LINK REL="PREVIOUS" TITLE="SDL_WM_GetCaption" HREF="sdlwmgetcaption.html"><LINK REL="NEXT" TITLE="SDL_WM_IconifyWindow" HREF="sdlwmiconifywindow.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdlwmgetcaption.html" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlwmiconifywindow.html" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLWMSETICON" >SDL_WM_SetIcon</A ></H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN3085" ></A ><H2 >Name</H2 >SDL_WM_SetIcon -- Sets the icon for the display window.</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN3088" ></A ><H2 >Synopsis</H2 ><DIV CLASS="FUNCSYNOPSIS" ><A NAME="AEN3089" ></A ><P ></P ><PRE CLASS="FUNCSYNOPSISINFO" >#include "SDL.h"</PRE ><P ><CODE ><CODE CLASS="FUNCDEF" >void <B CLASS="FSFUNC" >SDL_WM_SetIcon</B ></CODE >(SDL_Surface *icon, Uint8 *mask);</CODE ></P ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3095" ></A ><H2 >Description</H2 ><P >Sets the icon for the display window.</P ><P >This function must be called before the first call to <A HREF="sdlsetvideomode.html" >SDL_SetVideoMode</A >.</P ><P >It takes an <TT CLASS="PARAMETER" ><I >icon</I ></TT > surface, and a <TT CLASS="PARAMETER" ><I >mask</I ></TT > in MSB format.</P ><P >If <TT CLASS="PARAMETER" ><I >mask</I ></TT > is <TT CLASS="LITERAL" >NULL</TT >, the entire icon surface will be used as the icon.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3106" ></A ><H2 >Example</H2 ><PRE CLASS="PROGRAMLISTING" >SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3109" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlsetvideomode.html" ><TT CLASS="FUNCTION" >SDL_SetVideoMode</TT ></A >, <A HREF="sdlwmsetcaption.html" ><TT CLASS="FUNCTION" >SDL_WM_SetCaption</TT ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlwmgetcaption.html" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlwmiconifywindow.html" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_WM_GetCaption</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="wm.html" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_WM_IconifyWindow</TD ></TR ></TABLE ></DIV ></BODY ></HTML >