SDL_MouseButtonEvent Structure

The SDL_MouseButtonEvent structure in SDL is used to handle mouse button events. These events occur when the user presses or releases a mouse button.

The structure provides detailed information about the event, such as which button was pressed, the position of the cursor, and the click state.

Structure Definition

Here is the definition of the SDL_MouseButtonEvent structure:

1typedef struct SDL_MouseButtonEvent {
2  Uint32 type;      // Event type, SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP
3  Uint32 timestamp; // Timestamp of the event
4  Uint32 windowID;  // The window with mouse focus
5  Uint32 which;     // The mouse instance ID
6  Uint8 button;     // The mouse button index
7  Uint8 state;      // SDL_PRESSED or SDL_RELEASED
8  Uint8 clicks;     // 1 for single-click, 2 for double-click
9  Sint32 x;         // X coordinate of the mouse
10  Sint32 y;         // Y coordinate of the mouse
11} SDL_MouseButtonEvent;

Key Members

• type: The type of event, either SDL_MOUSEBUTTONDOWN (button pressed) or SDL_MOUSEBUTTONUP (button released).
• button: The mouse button that was pressed or released. Common values include SDL_BUTTON_LEFT, SDL_BUTTON_RIGHT, and SDL_BUTTON_MIDDLE.
• state: Indicates whether the button is pressed (SDL_PRESSED) or released (SDL_RELEASED).
• clicks: Number of clicks, useful for detecting single or double clicks.
• x, y: The coordinates of the mouse cursor when the event occurred.

Usage Example

Here’s an example of handling mouse button events using the SDL_MouseButtonEvent structure:

1#include <SDL.h>
2#include <iostream>
3
4void HandleMouseButtonEvent(
5  const SDL_MouseButtonEvent& buttonEvent) {
6  if (buttonEvent.state == SDL_PRESSED) {
7    std::cout << "Mouse button pressed at ("
8      << buttonEvent.x << ", "
9      << buttonEvent.y << ")\n";
10  } else if (buttonEvent.state == SDL_RELEASED) {
11    std::cout << "Mouse button released at ("
12      << buttonEvent.x << ", "
13      << buttonEvent.y << ")\n";
14  }
15}
16
17int main(int argc, char* argv[]) {
18  if (SDL_Init(SDL_INIT_VIDEO) != 0) {
19    std::cerr << "SDL_Init Error: "
20      << SDL_GetError() << '\n';
21    return 1;
22  }
23
24  SDL_Window* window = SDL_CreateWindow(
25    "Mouse Button Event",
26    100, 100, 640, 480,
27    SDL_WINDOW_SHOWN
28  );
29
30  if (window == nullptr) {
31    std::cerr << "SDL_CreateWindow Error: "
32      << SDL_GetError() << '\n';
33    SDL_Quit();
34    return 1;
35  }
36
37  SDL_Event event;
38  bool running = true;
39  while (running) {
40    while (SDL_PollEvent(&event)) {
41      if (event.type == SDL_QUIT) {
42        running = false;
43      } else if (event.type == SDL_MOUSEBUTTONDOWN ||
44                 event.type == SDL_MOUSEBUTTONUP) {
45        HandleMouseButtonEvent(event.button);
46      }
47    }
48  }
49
50  SDL_DestroyWindow(window);
51  SDL_Quit();
52  return 0;
53}

1Mouse button pressed at (200, 150)
2Mouse button released at (200, 150)

Summary

The SDL_MouseButtonEvent structure is essential for handling mouse button events in SDL. It provides detailed information, including the type of button event, the button involved, the state (pressed or released), the number of clicks, and the cursor's position.

By understanding and utilizing this structure, you can effectively manage mouse interactions in your SDL applications.