Mercurial > sdl-ios-xcode

<HTML
><HEAD
><TITLE
>SDL_WM_SetIcon</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><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
SUMMARY="Header navigation 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"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlwmiconifywindow.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLWMSETICON"
></A
>SDL_WM_SetIcon</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3582"
></A
><H2
>Name</H2
>SDL_WM_SetIcon&nbsp;--&nbsp;Sets the icon for the display window.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3585"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN3586"
></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="AEN3592"
></A
><H2
>Description</H2
><P
>Sets the icon for the display window. Win32 icons must be 32x32.</P
><P
>This function must be called before the first call to
<A
HREF="sdlsetvideomode.html"
>SDL_SetVideoMode</A
>.</P
><P
>The <TT
CLASS="PARAMETER"
><I
>mask</I
></TT
> is a bitmask that describes the shape of the
icon. If <TT
CLASS="PARAMETER"
><I
>mask</I
></TT
> is NULL, then the shape is determined by
the colorkey of <TT
CLASS="PARAMETER"
><I
>icon</I
></TT
>, if any, or makes the icon
rectangular (no transparency) otherwise.</P
><P
>If <TT
CLASS="PARAMETER"
><I
>mask</I
></TT
> is non-NULL, it points to a bitmap with bits set
where the corresponding pixel should be visible. The format of the bitmap is as
follows: Scanlines come in the usual top-down order. Each scanline consists of
(width / 8) bytes, rounded up. The most significant bit of each byte represents
the leftmost pixel.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3603"
></A
><H2
>Example</H2
><PRE
CLASS="PROGRAMLISTING"
>SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3606"
></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
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlwmgetcaption.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlwmiconifywindow.html"
ACCESSKEY="N"
>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"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_WM_IconifyWindow</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
author	Ryan C. Gordon <icculus@icculus.org>
date	Thu, 22 Sep 2005 08:48:16 +0000
parents	355632dca928
children