table of contents
SDL_RegisterApp(3) | SDL3 FUNCTIONS | SDL_RegisterApp(3) |
NAME¶
SDL_RegisterApp - Register a win32 window class for SDL's use.
HEADER FILE¶
Defined in SDL3/SDL_main.h
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_RegisterApp(const char *name, Uint32 style, void *hInst);
DESCRIPTION¶
This can be called to set the application window class at startup. It is safe to call this multiple times, as long as every call is eventually paired with a call to SDL_UnregisterApp , but a second registration attempt while a previous registration is still active will be ignored, other than to increment a counter.
Most applications do not need to, and should not, call this directly; SDL will call it when initializing the video subsystem.
FUNCTION PARAMETERS¶
- name
- the window class name, in UTF-8 encoding. If NULL, SDL currently uses " SDL_app " but this isn't guaranteed.
- style
- the value to use in WNDCLASSEX::style. If name is NULL, SDL currently uses (CS_BYTEALIGNCLIENT|CS_OWNDC) regardless of what is specified here.
- hInst
- the HINSTANCE to use in WNDCLASSEX::hInstance. If zero, SDL will use GetModuleHandle(NULL) instead.
RETURN VALUE¶
Returns 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SDL 3.1.2 | Simple Directmedia Layer |