SDL_GetMouseNameForID - Man Page

Get the name of a mouse.

Synopsis

#include <SDL3/SDL_mouse.h>

const char * SDL_GetMouseNameForID(SDL_MouseID instance_id);

Description

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

Function Parameters

instance_id

the mouse instance ID.

Return Value

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

Thread Safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_GetMice(3)

Referenced By

SDL_GetMice(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS