Browse Source

Renamed display added/removed events for consistency with the rest of the API

Fixes https://github.com/libsdl-org/SDL/issues/8425
Sam Lantinga 1 year ago
parent
commit
c98a14fdeb

+ 1 - 1
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

+ 2 - 2
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,

+ 4 - 4
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

+ 2 - 2
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;

+ 2 - 2
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

+ 4 - 4
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:

+ 1 - 1
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);

+ 3 - 3
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);

+ 1 - 1
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);
         }
     }
 }