kolibrios/contrib/sdk/sources/SDL-1.2.2/docs/html/sdlwmseticon.html
CleverMouse 3cf7852e03 autobuild sdlquake
git-svn-id: svn://kolibrios.org@5131 a494cfbc-eb01-0410-851d-a64ba20cac60
2014-09-18 11:46:53 +00:00

244 lines
3.0 KiB
HTML

<HTML
><HEAD
><TITLE
>SDL_WM_SetIcon</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
"><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="AEN3160"
></A
><H2
>Name</H2
>SDL_WM_SetIcon&nbsp;--&nbsp;Sets the icon for the display window.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3163"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN3164"
></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="AEN3170"
></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="AEN3181"
></A
><H2
>Example</H2
><PRE
CLASS="PROGRAMLISTING"
>SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3184"
></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
>