Refactor color handling into a new Color type

arcade/__init__.py

@@ -66,15 +66,7 @@ def configure_logging(level: Optional[int] = None):
 # pyglet.options['win32_gdi_font'] = True
 
 # Imports from modules that don't do anything circular
-from .drawing_support import get_four_byte_color
-from .drawing_support import get_three_float_color
-from .drawing_support import get_four_float_color
 from .drawing_support import get_points_for_thick_line
-from .drawing_support import make_transparent_color
-from .drawing_support import uint24_to_three_byte_color
-from .drawing_support import uint32_to_four_byte_color
-from .drawing_support import color_from_hex_string
-from .drawing_support import float_to_byte_color
 
 # Complex imports with potential circularity
 from .window_commands import close_window
@@ -291,7 +283,6 @@ def configure_logging(level: Optional[int] = None):
     'check_for_collision_with_list',
     'check_for_collision_with_lists',
     'close_window',
-    'color_from_hex_string',
     'disable_timings',
     'draw_arc_filled',
     'draw_arc_outline',
@@ -325,13 +316,10 @@ def configure_logging(level: Optional[int] = None):
     'enable_timings',
     'exit',
     'finish_render',
-    'float_to_byte_color',
     'get_closest_sprite',
     'get_display_size',
     'get_distance_between_sprites',
     'get_sprites_in_rect',
-    'get_four_byte_color',
-    'get_four_float_color',
     'get_controllers',
     'get_game_controllers',
     'get_image',
@@ -343,7 +331,6 @@ def configure_logging(level: Optional[int] = None):
     'get_sprites_at_point',
     'SpatialHash',
     'get_timings',
-    'get_three_float_color',
     'create_text_sprite',
     'clear_timings',
     'get_window',
@@ -359,7 +346,6 @@ def configure_logging(level: Optional[int] = None):
     'make_circle_texture',
     'make_soft_circle_texture',
     'make_soft_square_texture',
-    'make_transparent_color',
     'open_window',
     'pause',
     'print_timings',
@@ -374,8 +360,6 @@ def configure_logging(level: Optional[int] = None):
     'start_render',
     'stop_sound',
     'timings_enabled',
-    'uint24_to_three_byte_color',
-    'uint32_to_four_byte_color',
     'unschedule',
     'schedule_once',
     'cleanup_texture_cache',

arcade/application.py

@@ -18,7 +18,7 @@
 from arcade import set_window
 from arcade.color import TRANSPARENT_BLACK
 from arcade.context import ArcadeContext
-from arcade.types import Color
+from arcade.types import Color, RGBA255, RGBA255OrNormalized
 from arcade import SectionManager
 from arcade.utils import is_raspberry_pi
 
@@ -240,14 +240,20 @@ def ctx(self) -> ArcadeContext:
 
     def clear(
             self,
-            color: Optional[Color] = None,
+            color: Optional[RGBA255OrNormalized] = None,
             normalized: bool = False,
             viewport: Optional[Tuple[int, int, int, int]] = None,
     ):
         """Clears the window with the configured background color
         set through :py:attr:`arcade.Window.background_color`.
 
-        :param Color color: Optional color overriding the current background color
+        :param color: (Optional) override the current background color
+            with one of the following:
+
+            1. A :py:class:`~arcade.types.Color` instance
+            2. A 4-length RGBA :py:class:`tuple` of byte values (0 to 255)
+            3. A 4-length RGBA :py:class:`tuple` of normalized floats (0.0 to 1.0)
+
         :param bool normalized: If the color format is normalized (0.0 -> 1.0) or byte values
         :param Tuple[int, int, int, int] viewport: The viewport range to clear
         """
@@ -263,22 +269,28 @@ def background_color(self) -> Color:
 
         Examples::
 
-            # Use Arcade's built in color values
+            # Use Arcade's built in Color values
             window.background_color = arcade.color.AMAZON
 
-            # Specify RGB value directly (red)
-            window.background_color = 255, 0, 0
+            # Set the background color with a custom Color instance
+            MY_RED = arcade.types.Color(255, 0, 0)
+            window.background_color = MY_RED
 
-        If the background color is an ``RGB`` value instead of ``RGBA``
-        we assume alpha value 255.
+            # Set the backgrund color directly from an RGBA tuple
+            window.background_color = 255, 0, 0, 255
+
+            # (Discouraged)
+            # Set the background color directly from an RGB tuple
+            # RGB tuples will assume 255 as the opacity / alpha value
+            window.background_color = 255, 0, 0
 
         :type: Color
         """
         return self._background_color
 
     @background_color.setter
-    def background_color(self, value: Color):
-        self._background_color = value
+    def background_color(self, value: RGBA255):
+        self._background_color = Color.from_iterable(value)
 
     def run(self) -> None:
         """
@@ -957,14 +969,20 @@ def add_section(self, section, at_index: Optional[int] = None, at_draw_order: Op
 
     def clear(
         self,
-        color: Optional[Color] = None,
+        color: Optional[RGBA255OrNormalized] = None,
         normalized: bool = False,
         viewport: Optional[Tuple[int, int, int, int]] = None,
     ):
         """Clears the View's Window with the configured background color
         set through :py:attr:`arcade.Window.background_color`.
 
-        :param Color color: Optional color overriding the current background color
+        :param color: (Optional) override the current background color
+            with one of the following:
+
+            1. A :py:class:`~arcade.types.Color` instance
+            2. A 4-length RGBA :py:class:`tuple` of byte values (0 to 255)
+            3. A 4-length RGBA :py:class:`tuple` of normalized floats (0.0 to 1.0)
+
         :param bool normalized: If the color format is normalized (0.0 -> 1.0) or byte values
         :param Tuple[int, int, int, int] viewport: The viewport range to clear
         """