(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

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.1.3.

See Also

• SDL_GetMice

---

CategoryAPI, CategoryAPIFunction, CategoryMouse

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.