Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_WM_SetIcon (3)

Name

SDL_WM_SetIcon - Sets the icon for the display window.

Synopsis

#include "SDL.h"

void SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask);

Description

SDL_WM_SetIcon(3)              SDL API Reference             SDL_WM_SetIcon(3)



NAME
       SDL_WM_SetIcon - Sets the icon for the display window.

SYNOPSIS
       #include "SDL.h"

       void SDL_WM_SetIcon(SDL_Surface *icon, Uint8 *mask);

DESCRIPTION
       Sets the icon for the display window. Win32 icons must be 32x32.

       This function must be called before the first call to SDL_SetVideoMode.

       It takes an icon surface, and a mask in MSB format.

       If mask is NULL, the entire icon surface will be used as the icon.

EXAMPLE
       SDL_WM_SetIcon(SDL_LoadBMP("icon.bmp"), NULL);

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_SetVideoMode, SDL_WM_SetCaption



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:02           SDL_WM_SetIcon(3)