sdlSetWindowIcon function

bool sdlSetWindowIcon(Pointer<SdlWindow> window, Pointer<SdlSurface> icon)

Set the icon for a window.

If this function is passed a surface with alternate representations, the surface will be interpreted as the content to be used for 100% display scale, and the alternate representations will be used for high DPI situations. For example, if the original surface is 32x32, then on a 2x macOS display or 200% display scale on Windows, a 64x64 version of the image will be used, if available. If a matching version of the image isn't available, the closest larger size image will be downscaled to the appropriate size and be used instead, if available. Otherwise, the closest smaller image will be upscaled and be used instead.

\param window the window to change. \param icon an SDL_Surface structure containing the icon for the window. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_Surface *icon)

Implementation

bool sdlSetWindowIcon(Pointer<SdlWindow> window, Pointer<SdlSurface> icon) {
  final sdlSetWindowIconLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlWindow> window, Pointer<SdlSurface> icon),
      int Function(Pointer<SdlWindow> window,
          Pointer<SdlSurface> icon)>('SDL_SetWindowIcon');
  return sdlSetWindowIconLookupFunction(window, icon) == 1;
}