Add screen access for GLFW, Linux

Author: gspencergoog

examples/glfw/FlutterEmbedderGLFW.cc

@@ -68,8 +68,31 @@ static void GLFWKeyCallback(GLFWwindow* window,
 }
 
 void GLFWwindowSizeCallback(GLFWwindow* window, int width, int height) {
+  int left, top;
+  glfwGetWindowPos(window, &left, &top);
   FlutterWindowMetricsEvent event = {};
   event.struct_size = sizeof(event);
+  event.window_id = 0;
+  event.screen_id = 0;
+  event.left = left * g_pixelRatio;
+  event.top = top * g_pixelRatio;
+  event.width = width * g_pixelRatio;
+  event.height = height * g_pixelRatio;
+  event.pixel_ratio = g_pixelRatio;
+  FlutterEngineSendWindowMetricsEvent(
+      reinterpret_cast<FlutterEngine>(glfwGetWindowUserPointer(window)),
+      &event);
+}
+
+void GLFWwindowPosCallback(GLFWwindow* window, int left, int top) {
+  int width, height;
+  glfwGetWindowSize(window, &width, &height);
+  FlutterWindowMetricsEvent event = {};
+  event.struct_size = sizeof(event);
+  event.window_id = 0;
+  event.screen_id = 0;
+  event.left = left * g_pixelRatio;
+  event.top = top * g_pixelRatio;
   event.width = width * g_pixelRatio;
   event.height = height * g_pixelRatio;
   event.pixel_ratio = g_pixelRatio;
@@ -150,6 +173,7 @@ int main(int argc, const char* argv[]) {
 
   glfwSetKeyCallback(window, GLFWKeyCallback);
   glfwSetWindowSizeCallback(window, GLFWwindowSizeCallback);
+  glfwSetWindowPosCallback(window, GLFWwindowPosCallback);
   glfwSetMouseButtonCallback(window, GLFWmouseButtonCallback);
 
   while (!glfwWindowShouldClose(window)) {

shell/platform/darwin/macos/framework/Source/FlutterEngine.mm

@@ -315,13 +315,13 @@ - (void)updateWindowMetrics {
   CGRect screenBounds = [view.screen convertRectToBacking:view.screen.bounds];
   const FlutterWindowMetricsEvent windowMetricsEvent = {
       .struct_size = sizeof(windowMetricsEvent),
+      .window_id = 0,
+      .screen_id = 0,
       .left = static_cast<size_t>(screenBounds.origin.x),
       .top = static_cast<size_t>(screenBounds.origin.y),
       .width = static_cast<size_t>(screenBounds.size.width),
       .height = static_cast<size_t>(screenBounds.size.height),
       .pixel_ratio = pixelRatio,
-      .window_id = 0,
-      .screen_id = 0,
   };
   FlutterEngineSendWindowMetricsEvent(_engine, &windowMetricsEvent);
 }

shell/platform/embedder/embedder.h

@@ -273,6 +273,9 @@ typedef bool (*TextureFrameCallback)(void* /* user data */,
                                      FlutterOpenGLTexture* /* texture out */);
 typedef void (*VsyncCallback)(void* /* user data */, intptr_t /* baton */);
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterOpenGLRendererConfig).
   size_t struct_size;
@@ -311,6 +314,9 @@ typedef struct {
   TextureFrameCallback gl_external_texture_frame_callback;
 } FlutterOpenGLRendererConfig;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterSoftwareRendererConfig).
   size_t struct_size;
@@ -329,6 +335,9 @@ typedef struct {
   };
 } FlutterRendererConfig;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterWindowMetricsEvent).
   size_t struct_size;
@@ -339,25 +348,28 @@ typedef struct {
   /// Pixel density scale factor for the window. This will be identical to the
   /// value of the pixel ratio for the screen that this window appears on.
   double pixel_ratio;
-  /// Physical vertical location of the top of the window.
-  size_t top;
   /// Physical horizontal location of the left side of the window.
   size_t left;
+  /// Physical vertical location of the top of the window.
+  size_t top;
   /// The id for the window that corresponds to these metrics.
   size_t window_id;
   /// The id of the screen that this window appears on.
   size_t screen_id;
 } FlutterWindowMetricsEvent;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterScreenMetricsEvent).
   size_t struct_size;
   /// The id for the screen that corresponds to these metrics.
   size_t screen_id;
-  /// Physical vertical location of the top of the window.
-  size_t top;
   /// Physical horizontal location of the left side of the window.
   size_t left;
+  /// Physical vertical location of the top of the window.
+  size_t top;
   /// Physical width of the screen.
   size_t width;
   /// Physical height of the screen.
@@ -426,6 +438,9 @@ typedef enum {
   kFlutterPointerSignalKindScroll,
 } FlutterPointerSignalKind;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterPointerEvent).
   size_t struct_size;
@@ -460,6 +475,9 @@ struct _FlutterPlatformMessageResponseHandle;
 typedef struct _FlutterPlatformMessageResponseHandle
     FlutterPlatformMessageResponseHandle;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterPlatformMessage).
   size_t struct_size;
@@ -524,6 +542,10 @@ extern const int32_t kFlutterSemanticsNodeIdBatchEnd;
 /// (i.e., during PipelineOwner.flushSemantics), which happens after
 /// compositing. Updates are then pushed to embedders via the registered
 /// `FlutterUpdateSemanticsNodeCallback`.
+///
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterSemanticsNode).
   size_t struct_size;
@@ -603,6 +625,10 @@ extern const int32_t kFlutterSemanticsCustomActionIdBatchEnd;
 /// Action overrides are custom actions that the application developer requests
 /// to be used in place of the standard actions in the `FlutterSemanticsAction`
 /// enum.
+///
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of the struct. Must be sizeof(FlutterSemanticsCustomAction).
   size_t struct_size;
@@ -641,6 +667,10 @@ typedef void (*FlutterTaskRunnerPostTaskCallback)(
 /// on a specified thread. There should be a 1-1 relationship between a thread
 /// and a task runner. It is undefined behavior to run a task on a thread that
 /// is not associated with its task runner.
+///
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterTaskRunnerDescription).
   size_t struct_size;
@@ -666,6 +696,9 @@ typedef struct {
   size_t identifier;
 } FlutterTaskRunnerDescription;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterCustomTaskRunners).
   size_t struct_size;
@@ -737,6 +770,9 @@ typedef struct {
   };
 } FlutterPlatformViewMutation;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterPlatformView).
   size_t struct_size;
@@ -770,6 +806,9 @@ typedef enum {
   kFlutterBackingStoreTypeSoftware,
 } FlutterBackingStoreType;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterBackingStore).
   size_t struct_size;
@@ -790,6 +829,9 @@ typedef struct {
   };
 } FlutterBackingStore;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterBackingStoreConfig).
   size_t struct_size;
@@ -805,6 +847,9 @@ typedef enum {
   kFlutterLayerContentTypePlatformView,
 } FlutterLayerContentType;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// This size of this struct. Must be sizeof(FlutterLayer).
   size_t struct_size;
@@ -839,6 +884,9 @@ typedef bool (*FlutterLayersPresentCallback)(const FlutterLayer** layers,
                                              size_t layers_count,
                                              void* user_data);
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// This size of this struct. Must be sizeof(FlutterCompositor).
   size_t struct_size;
@@ -863,6 +911,9 @@ typedef struct {
   FlutterLayersPresentCallback present_layers_callback;
 } FlutterCompositor;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// This size of this struct. Must be sizeof(FlutterLocale).
   size_t struct_size;
@@ -901,6 +952,9 @@ typedef enum {
   kFlutterEngineDartObjectTypeBuffer,
 } FlutterEngineDartObjectType;
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterEngineDartBuffer).
   size_t struct_size;
@@ -1036,6 +1090,9 @@ FlutterEngineResult FlutterEngineCreateAOTData(
 FLUTTER_EXPORT
 FlutterEngineResult FlutterEngineCollectAOTData(FlutterEngineAOTData data);
 
+/// The order, type, and size of these struct members must remain the same, and
+/// members should not be removed. This is to allow for forward and backward
+/// compatibility between the engine and the embedder.
 typedef struct {
   /// The size of this struct. Must be sizeof(FlutterProjectArgs).
   size_t struct_size;

shell/platform/glfw/flutter_glfw.cc

@@ -196,13 +196,17 @@ static double GetScreenCoordinatesPerInch() {
 // Sends a window metrics update to the Flutter engine using the given
 // framebuffer size and the current window information in |state|.
 static void SendScreenMetrics(FlutterDesktopWindowControllerState* controller,
+                              int left,
+                              int top,
                               int width,
                               int height) {
   double dpi = controller->window_wrapper->pixels_per_screen_coordinate *
                controller->monitor_screen_coordinates_per_inch;
 
   FlutterScreenMetricsEvent event = {};
   event.struct_size = sizeof(event);
+  event.left = left;
+  event.top = top;
   event.width = width;
   event.height = height;
   if (controller->window_wrapper->pixel_ratio_override == 0.0) {
@@ -220,13 +224,17 @@ static void SendScreenMetrics(FlutterDesktopWindowControllerState* controller,
 // Sends a window metrics update to the Flutter engine using the given
 // framebuffer size and the current window information in |state|.
 static void SendWindowMetrics(FlutterDesktopWindowControllerState* controller,
+                              int left,
+                              int top,
                               int width,
                               int height) {
   double dpi = controller->window_wrapper->pixels_per_screen_coordinate *
                controller->monitor_screen_coordinates_per_inch;
 
   FlutterWindowMetricsEvent event = {};
   event.struct_size = sizeof(event);
+  event.left = left;
+  event.top = top;
   event.width = width;
   event.height = height;
   if (controller->window_wrapper->pixel_ratio_override == 0.0) {
@@ -264,14 +272,15 @@ static void ConfigurePlatformTaskRunner(
 static void GLFWFramebufferSizeCallback(GLFWwindow* window,
                                         int width_px,
                                         int height_px) {
+  int left_px, top_px;
+  glfwGetWindowPos(window, &left_px, &top_px);
   int width;
   glfwGetWindowSize(window, &width, nullptr);
   auto* controller = GetWindowController(window);
   controller->window_wrapper->pixels_per_screen_coordinate =
       width > 0 ? width_px / width : 1;
 
-  SendScreenMetrics(controller, width_px, height_px);
-  SendWindowMetrics(controller, width_px, height_px);
+  SendWindowMetrics(controller, left_px, top_px, width_px, height_px);
   controller->window_wrapper->skip_next_window_refresh = true;
 }
 
@@ -284,11 +293,27 @@ void GLFWWindowRefreshCallback(GLFWwindow* window) {
   }
   // There's no engine API to request a redraw explicitly, so instead send a
   // window metrics event with the current size to trigger it.
+  int left_px, top_px;
+  glfwGetWindowPos(window, &left_px, &top_px);
   int width_px, height_px;
   glfwGetFramebufferSize(window, &width_px, &height_px);
   if (width_px > 0 && height_px > 0) {
-    SendScreenMetrics(controller, width_px, height_px);
-    SendWindowMetrics(controller, width_px, height_px);
+    SendWindowMetrics(controller, left_px, top_px, width_px, height_px);
+  }
+}
+
+// Indicates that the window has moved.
+void GLFWWindowPosCallback(GLFWwindow* window, int left_px, int top_px) {
+  auto* controller = GetWindowController(window);
+  int width_px, height_px;
+  glfwGetFramebufferSize(window, &width_px, &height_px);
+
+  if (controller->window_wrapper->skip_next_window_refresh) {
+    controller->window_wrapper->skip_next_window_refresh = false;
+    return;
+  }
+  if (width_px > 0 && height_px > 0) {
+    SendWindowMetrics(controller, left_px, top_px, width_px, height_px);
   }
 }
 
@@ -809,12 +834,16 @@ FlutterDesktopWindowControllerRef FlutterDesktopCreateWindow(
 
   // Trigger an initial size callback to send size information to Flutter.
   state->monitor_screen_coordinates_per_inch = GetScreenCoordinatesPerInch();
+  int left_px, top_px;
+  glfwGetWindowPos(window, &left_px, &top_px);
+  GLFWWindowPosCallback(window, left_px, top_px);
   int width_px, height_px;
   glfwGetFramebufferSize(window, &width_px, &height_px);
   GLFWFramebufferSizeCallback(window, width_px, height_px);
 
   // Set up GLFW callbacks for the window.
   glfwSetFramebufferSizeCallback(window, GLFWFramebufferSizeCallback);
+  glfwSetWindowPosCallback(window, GLFWWindowPosCallback);
   glfwSetWindowRefreshCallback(window, GLFWWindowRefreshCallback);
   GLFWAssignEventCallbacks(window);
 
@@ -904,10 +933,12 @@ void FlutterDesktopWindowSetPixelRatioOverride(
   // Send a metrics update using the new pixel ratio.
   int width_px, height_px;
   glfwGetFramebufferSize(flutter_window->window, &width_px, &height_px);
+  int left_px, top_px;
+  glfwGetWindowPos(flutter_window->window, &left_px, &top_px);
   if (width_px > 0 && height_px > 0) {
     auto* controller = GetWindowController(flutter_window->window);
-    SendScreenMetrics(controller, width_px, height_px);
-    SendWindowMetrics(controller, width_px, height_px);
+    SendScreenMetrics(controller, left_px, top_px, width_px, height_px);
+    SendWindowMetrics(controller, left_px, top_px, width_px, height_px);
   }
 }