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

SDL_GetMice

Get a list of currently connected mice.

Header File

Syntax

SDL_MouseID * SDL_GetMice(int *count);

Function Parameters

int *

count

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

Return Value

(SDL_MouseID *) 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.

Remarks

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.