SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetMice

Get a list of currently connected mice.

Header File

Defined in <SDL3/SDL_mouse.h>

Syntax

const 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

(const SDL_MouseID *) Returns a 0 terminated array of mouse instance IDs or NULL on failure; call SDL_GetError() for more information.

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.

This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryMouse


[ edit | delete | history | feedback | raw ]

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