From c98a14fdeba77e7e6fccacc36a6657839a801f40 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Mon, 23 Oct 2023 08:59:07 -0700
Subject: [PATCH] Renamed display added/removed events for consistency with the
rest of the API
Fixes https://github.com/libsdl-org/SDL/issues/8425
---
docs/README-migration.md | 2 +-
include/SDL3/SDL_events.h | 4 ++--
include/SDL3/SDL_oldnames.h | 8 ++++----
src/events/SDL_displayevents.c | 4 ++--
src/events/SDL_events.c | 4 ++--
src/test/SDL_test_common.c | 8 ++++----
src/video/SDL_sysvideo.h | 2 +-
src/video/SDL_video.c | 6 +++---
src/video/windows/SDL_windowsmodes.c | 2 +-
9 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/README-migration.md b/docs/README-migration.md
index db1b8db00669..ae1693de7c9b 100644
--- a/docs/README-migration.md
+++ b/docs/README-migration.md
@@ -738,7 +738,7 @@ The following functions have been renamed:
* SDL_PixelFormatEnumToMasks() => SDL_GetMasksForPixelFormatEnum()
The following symbols have been renamed:
-* SDL_DISPLAYEVENT_DISCONNECTED => SDL_EVENT_DISPLAY_DISCONNECTED
+* SDL_DISPLAYEVENT_DISCONNECTED => SDL_EVENT_DISPLAY_REMOVED
* SDL_DISPLAYEVENT_MOVED => SDL_EVENT_DISPLAY_MOVED
* SDL_DISPLAYEVENT_ORIENTATION => SDL_EVENT_DISPLAY_ORIENTATION
* SDL_WINDOWEVENT_CLOSE => SDL_EVENT_WINDOW_CLOSE_REQUESTED
diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h
index a3c5cced02de..4e93b0fb1305 100644
--- a/include/SDL3/SDL_events.h
+++ b/include/SDL3/SDL_events.h
@@ -92,8 +92,8 @@ typedef enum
/* Display events */
/* 0x150 was SDL_DISPLAYEVENT, reserve the number for sdl2-compat */
SDL_EVENT_DISPLAY_ORIENTATION = 0x151, /**< Display orientation has changed to data1 */
- SDL_EVENT_DISPLAY_CONNECTED, /**< Display has been added to the system */
- SDL_EVENT_DISPLAY_DISCONNECTED, /**< Display has been removed from the system */
+ SDL_EVENT_DISPLAY_ADDED, /**< Display has been added to the system */
+ SDL_EVENT_DISPLAY_REMOVED, /**< Display has been removed from the system */
SDL_EVENT_DISPLAY_MOVED, /**< Display has changed position */
SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED, /**< Display has changed content scale */
SDL_EVENT_DISPLAY_FIRST = SDL_EVENT_DISPLAY_ORIENTATION,
diff --git a/include/SDL3/SDL_oldnames.h b/include/SDL3/SDL_oldnames.h
index 68f33080eabf..9eb699456469 100644
--- a/include/SDL3/SDL_oldnames.h
+++ b/include/SDL3/SDL_oldnames.h
@@ -91,8 +91,8 @@
#define SDL_ControllerDeviceEvent SDL_GamepadDeviceEvent
#define SDL_ControllerSensorEvent SDL_GamepadSensorEvent
#define SDL_ControllerTouchpadEvent SDL_GamepadTouchpadEvent
-#define SDL_DISPLAYEVENT_CONNECTED SDL_EVENT_DISPLAY_CONNECTED
-#define SDL_DISPLAYEVENT_DISCONNECTED SDL_EVENT_DISPLAY_DISCONNECTED
+#define SDL_DISPLAYEVENT_CONNECTED SDL_EVENT_DISPLAY_ADDED
+#define SDL_DISPLAYEVENT_DISCONNECTED SDL_EVENT_DISPLAY_REMOVED
#define SDL_DISPLAYEVENT_MOVED SDL_EVENT_DISPLAY_MOVED
#define SDL_DISPLAYEVENT_ORIENTATION SDL_EVENT_DISPLAY_ORIENTATION
#define SDL_DROPBEGIN SDL_EVENT_DROP_BEGIN
@@ -539,8 +539,8 @@
#define SDL_ControllerDeviceEvent SDL_ControllerDeviceEvent_renamed_SDL_GamepadDeviceEvent
#define SDL_ControllerSensorEvent SDL_ControllerSensorEvent_renamed_SDL_GamepadSensorEvent
#define SDL_ControllerTouchpadEvent SDL_ControllerTouchpadEvent_renamed_SDL_GamepadTouchpadEvent
-#define SDL_DISPLAYEVENT_CONNECTED SDL_DISPLAYEVENT_CONNECTED_renamed_SDL_EVENT_DISPLAY_CONNECTED
-#define SDL_DISPLAYEVENT_DISCONNECTED SDL_DISPLAYEVENT_DISCONNECTED_renamed_SDL_EVENT_DISPLAY_DISCONNECTED
+#define SDL_DISPLAYEVENT_CONNECTED SDL_DISPLAYEVENT_CONNECTED_renamed_SDL_EVENT_DISPLAY_ADDED
+#define SDL_DISPLAYEVENT_DISCONNECTED SDL_DISPLAYEVENT_DISCONNECTED_renamed_SDL_EVENT_DISPLAY_REMOVED
#define SDL_DISPLAYEVENT_MOVED SDL_DISPLAYEVENT_MOVED_renamed_SDL_EVENT_DISPLAY_MOVED
#define SDL_DISPLAYEVENT_ORIENTATION SDL_DISPLAYEVENT_ORIENTATION_renamed_SDL_EVENT_DISPLAY_ORIENTATION
#define SDL_DROPBEGIN SDL_DROPBEGIN_renamed_SDL_EVENT_DROP_BEGIN
diff --git a/src/events/SDL_displayevents.c b/src/events/SDL_displayevents.c
index edccb033f624..2e1a2ceaf78c 100644
--- a/src/events/SDL_displayevents.c
+++ b/src/events/SDL_displayevents.c
@@ -54,8 +54,8 @@ int SDL_SendDisplayEvent(SDL_VideoDisplay *display, SDL_EventType displayevent,
}
switch (displayevent) {
- case SDL_EVENT_DISPLAY_CONNECTED:
- SDL_OnDisplayConnected(display);
+ case SDL_EVENT_DISPLAY_ADDED:
+ SDL_OnDisplayAdded(display);
break;
default:
break;
diff --git a/src/events/SDL_events.c b/src/events/SDL_events.c
index 13aa0ca9e8e5..ed40fd1e8d35 100644
--- a/src/events/SDL_events.c
+++ b/src/events/SDL_events.c
@@ -222,8 +222,8 @@ static void SDL_LogEvent(const SDL_Event *event)
(uint)event->display.timestamp, (uint)event->display.displayID, name, (int)event->display.data1); \
break
SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_ORIENTATION);
- SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_CONNECTED);
- SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_DISCONNECTED);
+ SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_ADDED);
+ SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_REMOVED);
SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_MOVED);
SDL_DISPLAYEVENT_CASE(SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED);
#undef SDL_DISPLAYEVENT_CASE
diff --git a/src/test/SDL_test_common.c b/src/test/SDL_test_common.c
index 57b65ea6bd07..e4b62709b965 100644
--- a/src/test/SDL_test_common.c
+++ b/src/test/SDL_test_common.c
@@ -1566,8 +1566,8 @@ static void SDLTest_PrintEvent(SDL_Event *event)
case SDL_EVENT_SYSTEM_THEME_CHANGED:
SDL_Log("SDL EVENT: System theme changed to %s\n", SystemThemeName());
break;
- case SDL_EVENT_DISPLAY_CONNECTED:
- SDL_Log("SDL EVENT: Display %" SDL_PRIu32 " connected",
+ case SDL_EVENT_DISPLAY_ADDED:
+ SDL_Log("SDL EVENT: Display %" SDL_PRIu32 " attached",
event->display.displayID);
break;
case SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED:
@@ -1585,8 +1585,8 @@ static void SDLTest_PrintEvent(SDL_Event *event)
SDL_Log("SDL EVENT: Display %" SDL_PRIu32 " changed orientation to %s",
event->display.displayID, DisplayOrientationName(event->display.data1));
break;
- case SDL_EVENT_DISPLAY_DISCONNECTED:
- SDL_Log("SDL EVENT: Display %" SDL_PRIu32 " disconnected",
+ case SDL_EVENT_DISPLAY_REMOVED:
+ SDL_Log("SDL EVENT: Display %" SDL_PRIu32 " removed",
event->display.displayID);
break;
case SDL_EVENT_WINDOW_SHOWN:
diff --git a/src/video/SDL_sysvideo.h b/src/video/SDL_sysvideo.h
index 20bb76912cbf..56530fbab780 100644
--- a/src/video/SDL_sysvideo.h
+++ b/src/video/SDL_sysvideo.h
@@ -521,7 +521,7 @@ extern SDL_bool SDL_HasWindows(void);
extern void SDL_RelativeToGlobalForWindow(SDL_Window *window, int rel_x, int rel_y, int *abs_x, int *abs_y);
extern void SDL_GlobalToRelativeForWindow(SDL_Window *window, int abs_x, int abs_y, int *rel_x, int *rel_y);
-extern void SDL_OnDisplayConnected(SDL_VideoDisplay *display);
+extern void SDL_OnDisplayAdded(SDL_VideoDisplay *display);
extern void SDL_OnWindowShown(SDL_Window *window);
extern void SDL_OnWindowHidden(SDL_Window *window);
extern void SDL_OnWindowMoved(SDL_Window *window);
diff --git a/src/video/SDL_video.c b/src/video/SDL_video.c
index 90a2467c519b..91f0c4b9f9e7 100644
--- a/src/video/SDL_video.c
+++ b/src/video/SDL_video.c
@@ -689,12 +689,12 @@ SDL_DisplayID SDL_AddVideoDisplay(const SDL_VideoDisplay *display, SDL_bool send
}
if (send_event) {
- SDL_SendDisplayEvent(new_display, SDL_EVENT_DISPLAY_CONNECTED, 0);
+ SDL_SendDisplayEvent(new_display, SDL_EVENT_DISPLAY_ADDED, 0);
}
return id;
}
-void SDL_OnDisplayConnected(SDL_VideoDisplay *display)
+void SDL_OnDisplayAdded(SDL_VideoDisplay *display)
{
SDL_Window *window;
@@ -715,7 +715,7 @@ void SDL_DelVideoDisplay(SDL_DisplayID displayID, SDL_bool send_event)
display = _this->displays[display_index];
if (send_event) {
- SDL_SendDisplayEvent(display, SDL_EVENT_DISPLAY_DISCONNECTED, 0);
+ SDL_SendDisplayEvent(display, SDL_EVENT_DISPLAY_REMOVED, 0);
}
SDL_free(display->name);
diff --git a/src/video/windows/SDL_windowsmodes.c b/src/video/windows/SDL_windowsmodes.c
index df80ba3f6f59..714c6f6387d1 100644
--- a/src/video/windows/SDL_windowsmodes.c
+++ b/src/video/windows/SDL_windowsmodes.c
@@ -677,7 +677,7 @@ void WIN_RefreshDisplays(SDL_VideoDevice *_this)
SDL_VideoDisplay *display = _this->displays[i];
SDL_DisplayData *driverdata = display->driverdata;
if (driverdata->state == DisplayAdded) {
- SDL_SendDisplayEvent(display, SDL_EVENT_DISPLAY_CONNECTED, 0);
+ SDL_SendDisplayEvent(display, SDL_EVENT_DISPLAY_ADDED, 0);
}
}
}