SDL_GetGDKDefaultUser

Gets a reference to the default user handle for GDK.

Header File

Defined in <SDL3/SDL_system.h>

Syntax

bool SDL_GetGDKDefaultUser(XUserHandle *outUserHandle);

Function Parameters

XUserHandle * outUserHandle a pointer to be filled in with the default user handle.

Return Value

(bool) Returns true if success or false on failure; call SDL_GetError() for more information.

Remarks

This is effectively a synchronous version of XUserAddAsync, which always prefers the default user and allows a sign-in UI.

Version

This function is available since SDL 3.2.0.

CategoryAPI, CategoryAPIFunction, CategorySystem