SDL_GetMouseNameForID(3)

SDL_GetMouseNameForID3

Get the name of a mouse.

Usage

#include "SDL3/SDL.h"

const char * SDL_GetMouseNameForID(SDL_MouseID instance_id);

Header file

Defined in SDL3/SDL_mouse.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.