SDL_GetMice - Man Page

Get a list of currently connected mice.

Synopsis

#include <SDL3/SDL_mouse.h>

SDL_MouseID * SDL_GetMice(int *count);

Description

Note that this will include any device or virtual driver that includes mouse functionality, including some game controllers, KVM switches, etc. You should wait for input from a device before you consider it actively in use.

Function Parameters

count

a pointer filled in with the number of mice returned, may be NULL.

Return Value

Returns a 0 terminated array of mouse instance IDs or NULL on failure; call SDL_GetError() for more information. This should be freed with SDL_free() when it is no longer needed.

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_GetMouseNameForID(3), SDL_HasMouse(3)

Referenced By

SDL_GetMouseNameForID(3), SDL_HasMouse(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS