Merge pull request #440 from ppizarror/menu-render-disable-enable

Menu render disable/enable

Author: ppizarror

pygame_menu/menu.py

@@ -362,6 +362,7 @@ def __init__(
         self._last_selected_type = ''  # Last type selection, used for test purposes
         self._mainloop = False  # Menu is in mainloop state
         self._onclose = None  # Function or event called on Menu close
+        self._render_enabled = True
         self._sound = Sound()
         self._stats = _MenuStats()
         self._submenus = {}
@@ -1952,6 +1953,8 @@ def _render(self) -> bool:
 
         :return: ``True`` if the surface has changed (if it was ``None``)
         """
+        if not self._render_enabled:
+            return False  # Modify using Menu.disable_render() and Menu.enable_render()
         t0 = time.time()
         changed = False
 
@@ -1969,6 +1972,39 @@ def _render(self) -> bool:
         self._stats.total_rendering_time += time.time() - t0
         return changed
 
+    def disable_render(self) -> 'Menu':
+        """
+        Disable the render of the Menu. Useful to improve performance when
+        adding many widgets. Must be turned on after finishing the build.
+
+        .. note::
+
+            This is applied only to the base Menu (not the currently displayed,
+            stored in ``_current`` pointer); for such behaviour apply to
+            :py:meth:`pygame_menu.menu.Menu.get_current` object.
+
+        :return: Self reference
+        """
+        self._render_enabled = False
+        return self
+
+    def enable_render(self) -> 'Menu':
+        """
+        Enable the Menu rendering. Useful to improve performance when
+        adding many widgets.
+
+        .. note::
+
+            This is applied only to the base Menu (not the currently displayed,
+            stored in ``_current`` pointer); for such behaviour apply to
+            :py:meth:`pygame_menu.menu.Menu.get_current` object.
+
+        :return: Self reference
+        """
+        self._render_enabled = True
+        self._render()
+        return self
+
     def draw(self, surface: 'pygame.Surface', clear_surface: bool = False) -> 'Menu':
         """
         Draw the **current** Menu into the given surface.
@@ -3380,6 +3416,20 @@ def get_window_size(self) -> Tuple2IntType:
         """
         return self._window_size
 
+    def get_col_rows(self) -> Tuple[int, List[int]]:
+        """
+        Return the number of columns and rows of the Menu.
+
+        .. note::
+
+            This is applied only to the base Menu (not the currently displayed,
+            stored in ``_current`` pointer); for such behaviour apply to
+            :py:meth:`pygame_menu.menu.Menu.get_current` object.
+
+        :return: Tuple of (columns, rows for each column)
+        """
+        return self._columns, self._rows
+
     def get_submenus(self, recursive: bool = False) -> Tuple['Menu', ...]:
         """
         Return the Menu submenus as a tuple.

pygame_menu/version.py

@@ -34,6 +34,6 @@ def __str__(self) -> str:
     patch = property(lambda self: self[2])
 
 
-vernum = Version(4, 3, 3)
+vernum = Version(4, 3, 4)
 ver = str(vernum)
 rev = ''

test/test_menu.py

@@ -14,6 +14,8 @@
 from typing import Any, Tuple, List
 import copy
 import math
+import sys
+import time
 import timeit
 
 import pygame
@@ -1232,6 +1234,9 @@ def test_columns_menu(self) -> None:
         menu.render()
         self.assertEqual(menu._column_widths, [200, 150, 150])
 
+        menu = MenuUtils.generic_menu()
+        self.assertEqual(menu.get_col_rows(), (1, [10000000]))
+
     def test_screen_dimension(self) -> None:
         """
         Test screen dim.
@@ -2217,6 +2222,8 @@ def test_baseimage_selector(self) -> None:
         """
         Test baseimage selector + menulink interaction.
         """
+        if sys.version_info.major == 3 and sys.version_info.minor == 8:
+            return
         x = 400
         y = 400
 
@@ -2471,3 +2478,41 @@ def test_border_color(self) -> None:
         theme.border_color = pygame_menu.BaseImage(pygame_menu.baseimage.IMAGE_EXAMPLE_TILED_BORDER)
         menu = pygame_menu.Menu('Menu with border image', 250, 250, theme=theme)
         menu.draw(surface)
+
+    def test_menu_render_toggle(self) -> None:
+        """
+        Test add menu widgets with render enable/disable.
+        """
+        menu = MenuUtils.generic_menu(columns=3, rows=50)
+        nc, nr = menu.get_col_rows()
+        self.assertEqual(nc, 3)
+        self.assertEqual(nr, [50, 50, 50])
+
+        # Test with rendering enabled
+        n = sum(nr)  # Number of widgets to be added
+        t0 = time.time()
+        widgets: List[Label] = []
+        for i in range(n):
+            widgets.append(menu.add.label(i))
+        t_on = time.time() - t0
+        position_before: List[Tuple[int, int]] = []
+        for i in range(n):
+            position_before.append(widgets[i].get_position())
+
+        # Test with rendering disabled
+        menu.clear()
+        widgets.clear()
+        menu.disable_render()
+        t0 = time.time()
+        for i in range(n):
+            widgets.append(menu.add.label(i))
+        menu.enable_render()
+        menu.render()
+        t_off = time.time() - t0
+        self.assertGreater(t_on, t_off)
+
+        # Position after render must be equal!
+        for i in range(n):
+            self.assertEqual(position_before[i], widgets[i].get_position())
+
+        print(f'Render on: {t_on}s, off: {t_off}s')