SDL_GetMice(3)

SDL_GetMice3

Get a list of currently connected mice.

Usage

#include "SDL3/SDL.h"

SDL_MouseID * SDL_GetMice(int *count);

Header file

Defined in SDL3/SDL_mouse.h

Overview

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

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

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.