SDL Event which Field

The which field, found in input-related event structures like SDL_MouseMotionEvent, SDL_MouseButtonEvent, SDL_MouseWheelEvent, SDL_KeyboardEvent, and joystick/controller events, serves as an identifier for the specific input device instance that generated the event.

Purpose: Handling Multiple Devices

Its primary purpose is to distinguish between input events when multiple devices of the same type are connected to the system.

• Multiple Mice/Keyboards: If a user has more than one mouse or keyboard plugged in (less common for desktops, but possible), the which field allows your application to identify which specific mouse moved or which specific keyboard generated a key press. Each connected device will typically have a unique instance ID assigned by SDL.
• Multiple Joysticks/Game Controllers: This is a very common use case. Most systems support multiple game controllers. The which field (often referred to as the instance ID in joystick/controller APIs) is essential for routing input from Player 1's controller to Player 1's character, Player 2's input to Player 2, and so on.

Example Scenario (Conceptual)

Here's an example event loop that applies these concepts:

1SDL_Event event;
2while (SDL_PollEvent(&event)) {
3  if (event.type == SDL_MOUSEBUTTONDOWN) {
4    std::cout << "Mouse button down event from device ID: "
5              << event.button.which << '\n'; 
6
7    if (event.button.which == 0) {
8      // Handle input from the first mouse
9    } else if (event.button.which == 1) {
10      // Handle input from the second mouse (if present)
11    }
12  } else if (event.type == SDL_JOYBUTTONDOWN) {
13    std::cout << "Joystick button down from instance ID: "
14              << event.jbutton.which << '\n'; 
15    // Route input based on joystick instance ID
16    RouteJoystickInput(event.jbutton.which, event.jbutton.button);
17  }
18}

Special Value: SDL_TOUCH_MOUSEID

There's a special predefined value, SDL_TOUCH_MOUSEID. If the which field in a mouse event structure equals this value, it indicates that the mouse event was synthesized from a touch event.

This happens on touch-enabled devices where SDL emulates mouse behavior based on touch input (e.g., a tap generating SDL_MOUSEBUTTONDOWN and SDL_MOUSEBUTTONUP). You can use this to differentiate between actual hardware mouse events and touch-emulated ones if necessary.

1if (event.type == SDL_MOUSEBUTTONDOWN) {
2  if (event.button.which == SDL_TOUCH_MOUSEID) {
3    std::cout << "This click came from a touch event.\n";
4  } else {
5    std::cout << "This click came from a hardware mouse (ID: "
6              << event.button.which << ").\n";
7  }
8}

When Is It Important?

For typical single-player desktop applications with one mouse and keyboard, you might often ignore the which field for mouse/keyboard events (implicitly handling input from the default device, usually ID 0).

However, it becomes crucial when developing applications that explicitly support multiple input devices of the same type, especially game controllers.