Add comments

Author: clarkezone

shell/platform/windows/flutter_windows_view.h

@@ -18,16 +18,16 @@
 #include "flutter/shell/platform/windows/keyboard_hook_handler.h"
 #include "flutter/shell/platform/windows/public/flutter_windows.h"
 #include "flutter/shell/platform/windows/text_input_plugin.h"
+#include "flutter/shell/platform/windows/win32_platform_handler.h"
 #include "flutter/shell/platform/windows/window_binding_handler.h"
 #include "flutter/shell/platform/windows/window_state.h"
-#include "flutter/shell/platform/windows/win32_platform_handler.h"
 
 namespace flutter {
 
 // Struct holding the mouse state. The engine doesn't keep track of which mouse
 // buttons have been pressed, so it's the embedding's responsibility.
 struct MouseState {
-  // True if the last event sent to Flutter had at least one mouse button
+  // True if the last event sent to Flutter had at least one mouse button.
   // pressed.
   bool flutter_state_is_down = false;
 
@@ -40,15 +40,15 @@ struct MouseState {
   uint64_t buttons = 0;
 };
 
-// A windowing neutral flutter child video used as implementation for flutter
-// view that works with win32 hwnds and Windows::UI::Composition visuals
+// An OS windowing neutral abstration for flutter
+// view that works with win32 hwnds and Windows::UI::Composition visuals.
 class FlutterWindowsView {
  public:
-  // Create flutter Window for use as child window
   FlutterWindowsView();
 
   ~FlutterWindowsView();
 
+  // Factory for creating FlutterWindowsView requiring an implementator of FlutterWindowBindingHandler.
   static FlutterDesktopViewControllerRef CreateFlutterWindowsView(
       std::unique_ptr<FlutterWindowBindingHandler> windowbinding);
 
@@ -63,11 +63,13 @@ class FlutterWindowsView {
   // messages.
   void HandlePlatformMessage(const FlutterPlatformMessage*);
 
+  // Create rendering surface for Flutter engine to draw into.
   void CreateRenderSurface();
 
   // Destroy current rendering surface if one has been allocated.
   void DestroyRenderSurface();
 
+  // Return the currently configured WindowsRenderTarget.
   WindowsRenderTarget* GetRenderTarget();
 
   // Callbacks for clearing context, settings context and swapping buffers.
@@ -76,40 +78,47 @@ class FlutterWindowsView {
   bool MakeResourceCurrent();
   bool SwapBuffers();
 
-  // TODO
+  // Notify view that backing window size has changed.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnWindowSizeChanged(size_t width, size_t height) const;
 
-  // TODO
+  // Notify view that backing window mouse has moved.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnPointerMove(double x, double y);
 
-  // TODO
+  // Notify view that backing window mouse pointer button has been pressed.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnPointerDown(double x, double y, FlutterPointerMouseButtons button);
 
-  // TODO
+  // Notify view that backing window mouse pointer button has been released.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnPointerUp(double x, double y, FlutterPointerMouseButtons button);
 
-  // TODO
+  // Notify view that backing window mouse pointer has left the window.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnPointerLeave();
 
-  // TODO
+  // Notify view that backing window has received text.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnText(const std::u16string&);
 
-  // TODO
+  // Notify view that backing window size has received key press.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnKey(int key, int scancode, int action, char32_t character);
 
-  // TODO
+  // Notify view that backing window size has recevied scroll.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnScroll(double x,
                 double y,
                 double delta_x,
                 double delta_y,
                 int scroll_offset_multiplier);
 
-  // TODO
+  // Notify view that backing window size has had system font change.
+  // Typically called by currently configured FlutterWindowBindingHandler
   void OnFontChange();
 
  private:
-  // TODO
-  void CreateRenderSurfaceHWND();
 
   // Sends a window metrics update to the Flutter engine using current window
   // dimensions in physical
@@ -179,7 +188,7 @@ class FlutterWindowsView {
   std::unique_ptr<AngleSurfaceManager> surface_manager = nullptr;
   EGLSurface render_surface = EGL_NO_SURFACE;
 
-  // state of the mouse button
+  // state of the mouse button.
   bool pointer_is_down_ = false;
 
   // The handle to the Flutter engine instance.
@@ -220,18 +229,13 @@ class FlutterWindowsView {
   // should we forword input messages or not
   bool process_events_ = false;
 
-  // flag indicating if the message loop should be running
+  // flag indicating if the message loop should be running.
   bool messageloop_running_ = false;
 
-  /* winrt::Windows::UI::Composition::Compositor compositor_ {nullptr};
-
-   winrt::Windows::UI::Composition::SpriteVisual
-   flutter_render_visual_{nullptr};*/
-
-  //::HWND window_rendertarget_;
-
+  // Currently configured WindowsRenderTarget for view.
   std::unique_ptr<WindowsRenderTarget> render_target_;
 
+  // Currently configured FlutterWindowBindingHandler for view.
   std::unique_ptr<flutter::FlutterWindowBindingHandler> binding_handler_{
       nullptr};
 };