verilog-to-routing · SamuelHo10 · May 15, 2025 · May 15, 2025 · May 15, 2025 · May 15, 2025
diff --git a/doc/_doxygen/ezgl.dox b/doc/_doxygen/ezgl.dox
@@ -0,0 +1,13 @@
+PROJECT_NAME           = "Verilog to Routing - EZGL"
+OUTPUT_DIRECTORY       = ../_build/doxygen/ezgl
+FULL_PATH_NAMES        = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+WARN_IF_UNDOCUMENTED   = NO
+INPUT                  = ../../libs/EXTERNAL/libezgl
+RECURSIVE              = YES
+GENERATE_HTML          = NO
+GENERATE_LATEX         = NO
+GENERATE_XML           = YES
diff --git a/doc/src/api/vtrutil/ezgl.rst b/doc/src/api/vtrutil/ezgl.rst
@@ -0,0 +1,18 @@
+.. _ezgl:
+
+====
+EZGL
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   ezgl_application
+   ezgl_callback
+   ezgl_camera
+   ezgl_canvas
+   ezgl_color
+   ezgl_control
+   ezgl_graphics
+   ezgl_point
+   ezgl_rectangle
diff --git a/doc/src/api/vtrutil/ezgl_application.rst b/doc/src/api/vtrutil/ezgl_application.rst
@@ -0,0 +1,6 @@
+===========
+Application
+===========
+
+.. doxygenfile:: application.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_callback.rst b/doc/src/api/vtrutil/ezgl_callback.rst
@@ -0,0 +1,56 @@
+==============
+EZGL Callbacks
+==============
+
+This module provides callback functions for handling keyboard and mouse input, as well as predefined button actions in EZGL applications.
+
+Input Event Callbacks
+--------------------
+
+.. doxygenfunction:: press_key
+   :project: ezgl
+
+.. doxygenfunction:: press_mouse
+   :project: ezgl
+
+.. doxygenfunction:: release_mouse
+   :project: ezgl
+
+.. doxygenfunction:: move_mouse
+   :project: ezgl
+
+.. doxygenfunction:: scroll_mouse
+   :project: ezgl
+
+Button Action Callbacks
+----------------------
+
+.. doxygenfunction:: press_zoom_fit
+   :project: ezgl
+
+.. doxygenfunction:: press_zoom_in
+   :project: ezgl
+
+.. doxygenfunction:: press_zoom_out
+   :project: ezgl
+
+Navigation Callbacks
+------------------
+
+.. doxygenfunction:: press_up
+   :project: ezgl
+
+.. doxygenfunction:: press_down
+   :project: ezgl
+
+.. doxygenfunction:: press_left
+   :project: ezgl
+
+.. doxygenfunction:: press_right
+   :project: ezgl
+
+Other Callbacks
+-------------
+
+.. doxygenfunction:: press_proceed
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_camera.rst b/doc/src/api/vtrutil/ezgl_camera.rst
@@ -0,0 +1,5 @@
+======
+Camera
+======
+.. doxygenfile:: camera.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_canvas.rst b/doc/src/api/vtrutil/ezgl_canvas.rst
@@ -0,0 +1,5 @@
+======
+Canvas
+======
+.. doxygenfile:: canvas.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_color.rst b/doc/src/api/vtrutil/ezgl_color.rst
@@ -0,0 +1,5 @@
+=====
+Color
+=====
+.. doxygenfile:: color.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_control.rst b/doc/src/api/vtrutil/ezgl_control.rst
@@ -0,0 +1,41 @@
+=======
+Control
+=======
+
+Functions to manipulate what is visible on the EZGL canvas. These functions are used by EZGL's predefined buttons, but application code can also call them directly when needed.
+
+Zoom Functions
+-------------
+
+.. doxygenfunction:: ezgl::zoom_in(canvas*, double)
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::zoom_out(canvas*, double)
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::zoom_in(canvas*, point2d, double)
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::zoom_out(canvas*, point2d, double)
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::zoom_fit
+   :project: ezgl
+
+Translation Functions
+--------------------
+
+.. doxygenfunction:: ezgl::translate
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::translate_up
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::translate_down
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::translate_left
+   :project: ezgl
+
+.. doxygenfunction:: ezgl::translate_right
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_graphics.rst b/doc/src/api/vtrutil/ezgl_graphics.rst
@@ -0,0 +1,5 @@
+========
+Graphics
+========
+.. doxygenfile:: graphics.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/ezgl_point.rst b/doc/src/api/vtrutil/ezgl_point.rst
@@ -0,0 +1,6 @@
+=====
+Point
+=====
+.. doxygenfile:: point.hpp
+   :project: ezgl
+
diff --git a/doc/src/api/vtrutil/ezgl_rectangle.rst b/doc/src/api/vtrutil/ezgl_rectangle.rst
@@ -0,0 +1,5 @@
+=========
+Rectangle
+=========
+.. doxygenfile:: rectangle.hpp
+   :project: ezgl
diff --git a/doc/src/api/vtrutil/index.rst b/doc/src/api/vtrutil/index.rst
@@ -12,4 +12,5 @@ VTRUTIL API
    logging
    geometry
    parallel
+   ezgl
    other
diff --git a/doc/src/conf.py b/doc/src/conf.py
@@ -155,6 +155,7 @@
         "odin_ii": "../_build/doxygen/odin_ii/xml",
         "blifexplorer": "../_build/doxygen/blifexplorer/xml",
         "librrgraph": "../_build/doxygen/librrgraph/xml",
+        "ezgl": "../_build/doxygen/ezgl/xml"
     }
     breathe_default_project = "vpr"
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,4 +12,5 @@ VTRUTIL API @@
        logging
        geometry
        parallel
+       ezgl
        other