SDL_GetMouseNameForID

Get the name of a mouse.

Header File

Defined in <SDL3/SDL_mouse.h>

Syntax

const char * SDL_GetMouseNameForID(SDL_MouseID instance_id);

Function Parameters

SDL_MouseID instance_id the mouse instance ID.

Return Value

(const char *) Returns the name of the selected mouse, or NULL on failure; call SDL_GetError() for more information.

Remarks

This function returns "" if the mouse doesn't have a name.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryMouse