Atlas tweaks again (#2187)

* Missing content in atlas ABC

* Texture interpolation using half pixels

* Allow force resize of texture atlase

* Test AtlasRegion

* AtlasRegion: Raise RuntimeError instead of ValueErrror

* Atlas: Allow force resizing

* Atlas: Update type annotations

* Remove NinePatchTexture.from_rect

* Fix ninepatch. It can't use center pixels for now

* import order

Author: einarf

arcade/gui/nine_patch.py

@@ -4,7 +4,6 @@
 
 import arcade
 import arcade.gl as gl
-from arcade.types.rect import Rect
 
 
 class NinePatchTexture:
@@ -96,7 +95,7 @@ def __init__(
         # References for the texture
         self._atlas = atlas or self.ctx.default_atlas
         self._texture = texture
-        self._set_texture(texture)
+        self._add_to_atlas(texture)
 
         # pixel texture co-ordinate start and end of central box.
         self._left = left
@@ -106,15 +105,6 @@ def __init__(
 
         self._check_sizes()
 
-    @classmethod
-    def from_rect(
-        cls, rect: Rect, texture: arcade.Texture, atlas: Optional[arcade.DefaultTextureAtlas] = None
-    ) -> NinePatchTexture:
-        """Construct a new SpriteSolidColor from a :py:class:`~arcade.types.rect.Rect`."""
-        return cls(
-            int(rect.left), int(rect.right), int(rect.bottom), int(rect.top), texture, atlas=atlas
-        )
-
     @property
     def ctx(self) -> arcade.ArcadeContext:
         """The OpenGL context."""
@@ -127,7 +117,8 @@ def texture(self) -> arcade.Texture:
 
     @texture.setter
     def texture(self, texture: arcade.Texture):
-        self._set_texture(texture)
+        self._texture = texture
+        self._add_to_atlas(texture)
 
     @property
     def program(self) -> gl.program.Program:
@@ -142,15 +133,14 @@ def program(self) -> gl.program.Program:
     def program(self, program: gl.program.Program):
         self._program = program
 
-    def _set_texture(self, texture: arcade.Texture):
+    def _add_to_atlas(self, texture: arcade.Texture):
         """
         Internal method for setting the texture.
 
         It ensures the texture is added to the global atlas.
         """
         if not self._atlas.has_texture(texture):
             self._atlas.add(texture)
-        self._texture = texture
 
     @property
     def left(self) -> int:

arcade/resources/system/shaders/gui/nine_patch_gs.glsl

@@ -65,20 +65,28 @@ void main() {
     //     )
     // Get texture coordinates
     vec2 uv0, uv1, uv2, uv3;
-    getSpriteUVs(uv_texture, int(texture_id), uv0, uv1, uv2, uv3);
     vec2 atlas_size = vec2(textureSize(sprite_texture, 0));
-    // Corner offsets (upper left, upper, right, lower left, lower right)
-    // This is the global texture coordiante offset in the entire atlas
+    getSpriteUVs(uv_texture, int(texture_id), uv0, uv1, uv2, uv3);
+    // TODO: Do center pixel interpolation. Revert by 0.5 pixels for now
+    vec2 half_px = 0.5 / atlas_size;
+    uv0 -= half_px;
+    uv1 += vec2(half_px.x, -half_px.y);
+    uv2 += vec2(-half_px.x, half_px.y);
+    uv3 += half_px;
+
+    // Local corner offsets in pixels
     float left = start.x;
     float right = t_size.x - end.x;
     float top = t_size.y - end.y;
     float bottom = start.y;
+    // UV offsets to the inner rectangle in the patch
+    // This is the global texture coordiante offset in the entire atlas
+    vec2 c1 = vec2(left, top) / atlas_size;      // Upper left corner
+    vec2 c2 = vec2(right, top) / atlas_size;     // Upper right corner
+    vec2 c3 = vec2(left, bottom) / atlas_size;   // Lower left corner
+    vec2 c4 = vec2(right, bottom) / atlas_size;  // Lower right corner
 
-    vec2 c1 = vec2(left, top) / atlas_size;
-    vec2 c2 = vec2(right, top) / atlas_size;
-    vec2 c3 = vec2(left, bottom) / atlas_size;
-    vec2 c4 = vec2(right, bottom) / atlas_size;
-
+    // Texture coordinates for all the points in the patch
     vec2 t1 = uv0;
     vec2 t2 = uv0 + vec2(c1.x, 0.0);
     vec2 t3 = uv1 - vec2(c2.x, 0.0);
@@ -100,9 +108,8 @@ void main() {
     vec2 t16 = uv3;
 
     mat4 mvp = window.projection * window.view;
-    // First row - two fixed corners + strechy middle - 8 vertices
-    // NOTE: This should ideally be done with 3 strips
-    // Upper left corner
+    // First row - two fixed corners + strechy middle
+    // Upper left corner. Fixed size.
     gl_Position = mvp * vec4(p1, 0.0, 1.0);
     uv = t1;
     EmitVertex();
@@ -117,7 +124,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Upper middle part
+    // Upper middle part streches on x axis
     gl_Position = mvp * vec4(p2, 0.0, 1.0);
     uv = t2;
     EmitVertex();
@@ -132,7 +139,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Upper right corner
+    // Upper right corner. Fixed size
     gl_Position = mvp * vec4(p3, 0.0, 1.0);
     uv = t3;
     EmitVertex();
@@ -147,8 +154,8 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // middle row - three strechy parts - 8 vertices
-    // left border
+    // Middle row: Two strechy sides + strechy middle
+    // left border steching on y axis
     gl_Position = mvp * vec4(p5, 0.0, 1.0);
     uv = t5;
     EmitVertex();
@@ -163,7 +170,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Center area
+    // Center strechy area
     gl_Position = mvp * vec4(p6, 0.0, 1.0);
     uv = t6;
     EmitVertex();
@@ -178,7 +185,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Right border
+    // Right border. Steches on y axis
     gl_Position = mvp * vec4(p7, 0.0, 1.0);
     uv = t7;
     EmitVertex();
@@ -193,8 +200,8 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // last row - two fixed corners + strechy middle - 8 vertices
-    // Lower left corner
+    // Bottom row: two fixed corners + strechy middle
+    // Lower left corner. Fixed size
     gl_Position = mvp * vec4(p9, 0.0, 1.0);
     uv = t9;
     EmitVertex();
@@ -209,7 +216,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Lower middle part
+    // Lower middle part. Streches on x axis
     gl_Position = mvp * vec4(p10, 0.0, 1.0);
     uv = t10;
     EmitVertex();
@@ -224,7 +231,7 @@ void main() {
     EmitVertex();
     EndPrimitive();
 
-    // Lower right corner
+    // Lower right corner. Fixed size
     gl_Position = mvp * vec4(p11, 0.0, 1.0);
     uv = t11;
     EmitVertex();

arcade/texture_atlas/atlas_default.py

@@ -5,11 +5,8 @@
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
-    Dict,
-    List,
     Optional,
     Sequence,
-    Tuple,
     Union,
 )
 from weakref import WeakSet, WeakValueDictionary, finalize
@@ -94,7 +91,7 @@ class DefaultTextureAtlas(TextureAtlasBase):
 
     def __init__(
         self,
-        size: Tuple[int, int],
+        size: tuple[int, int],
         *,
         border: int = 1,
         textures: Optional[Sequence["Texture"]] = None,
@@ -104,7 +101,7 @@ def __init__(
     ):
         self._ctx = ctx or get_window().ctx
         self._max_size = self._ctx.info.MAX_VIEWPORT_DIMS
-        self._size: Tuple[int, int] = size
+        self._size: tuple[int, int] = size
         self._allocator = Allocator(*self._size)
         self._auto_resize = auto_resize
         self._capacity = capacity
@@ -143,8 +140,8 @@ def __init__(
         # The texture regions are clones of the image regions with transforms applied
         # in order to map the same image using different orders or texture coordinates.
         # The key is the cache name for a texture
-        self._image_regions: Dict[str, AtlasRegion] = dict()
-        self._texture_regions: Dict[str, AtlasRegion] = dict()
+        self._image_regions: dict[str, AtlasRegion] = dict()
+        self._texture_regions: dict[str, AtlasRegion] = dict()
 
         # Ref counter for images and textures. Per atlas we need to keep
         # track of ho many times an image is used in textures to determine
@@ -162,7 +159,7 @@ def __init__(
         # All textures added to the atlas
         self._textures: WeakSet[Texture] = WeakSet()
         # atlas_name: Set of textures with matching atlas name
-        self._unique_textures: Dict[str, WeakSet["Texture"]] = dict()
+        self._unique_textures: dict[str, WeakSet["Texture"]] = dict()
 
         # Add all the textures
         for tex in textures or []:
@@ -187,7 +184,7 @@ def max_height(self) -> int:
         return self._max_size[1]
 
     @property
-    def max_size(self) -> Tuple[int, int]:
+    def max_size(self) -> tuple[int, int]:
         """
         The maximum size of the atlas in pixels (x, y)
         """
@@ -227,7 +224,7 @@ def texture_uv_texture(self) -> "Texture2D":
         return self._texture_uvs.texture
 
     @property
-    def textures(self) -> List["Texture"]:
+    def textures(self) -> list["Texture"]:
         """
         All textures instance added to the atlas regardless
         of their internal state. See :py:meth:`unique_textures``
@@ -236,7 +233,7 @@ def textures(self) -> List["Texture"]:
         return list(self._textures)
 
     @property
-    def unique_textures(self) -> List["Texture"]:
+    def unique_textures(self) -> list["Texture"]:
         """
         All unique textures in the atlas.
 
@@ -245,23 +242,23 @@ def unique_textures(self) -> List["Texture"]:
         can be found in :py:meth:`textures`.
         """
         # Grab the first texture from each set
-        textures: List[Texture] = []
+        textures: list[Texture] = []
         for tex_set in self._unique_textures.values():
             if len(tex_set) == 0:
                 raise RuntimeError("Empty set in unique textures")
             textures.append(next(iter(tex_set)))
         return textures
 
     @property
-    def images(self) -> List["ImageData"]:
+    def images(self) -> list["ImageData"]:
         """
         Return a list of all the images in the atlas.
 
         A new list is constructed from the internal weak set of images.
         """
         return list(self._images.values())
 
-    def add(self, texture: "Texture") -> Tuple[int, AtlasRegion]:
+    def add(self, texture: "Texture") -> tuple[int, AtlasRegion]:
         """
         Add a texture to the atlas.
 
@@ -271,7 +268,7 @@ def add(self, texture: "Texture") -> Tuple[int, AtlasRegion]:
         """
         return self._add(texture)
 
-    def _add(self, texture: "Texture", create_finalizer=True) -> Tuple[int, AtlasRegion]:
+    def _add(self, texture: "Texture", create_finalizer=True) -> tuple[int, AtlasRegion]:
         """
         Internal add method with additional control. We we rebuild the atlas
         we don't want to create finalizers for the texture or they will be
@@ -367,7 +364,7 @@ def remove(self, texture: "Texture") -> None:
             "and let the python garbage collector handle the removal."
         )
 
-    def _allocate_texture(self, texture: "Texture") -> Tuple[int, AtlasRegion]:
+    def _allocate_texture(self, texture: "Texture") -> tuple[int, AtlasRegion]:
         """
         Add or update a unique texture in the atlas.
         This is mainly responsible for updating the texture coordinates
@@ -391,7 +388,7 @@ def _allocate_texture(self, texture: "Texture") -> Tuple[int, AtlasRegion]:
 
         return slot, texture_region
 
-    def _allocate_image(self, image_data: "ImageData") -> Tuple[int, int, int, AtlasRegion]:
+    def _allocate_image(self, image_data: "ImageData") -> tuple[int, int, int, AtlasRegion]:
         """
         Attempts to allocate space for an image in the atlas or
         update the existing space for the image.
@@ -593,7 +590,7 @@ def has_image(self, image_data: "ImageData") -> bool:
         """Check if an image is already in the atlas"""
         return image_data.hash in self._images
 
-    def resize(self, size: Tuple[int, int]) -> None:
+    def resize(self, size: tuple[int, int], force=False) -> None:
         """
         Resize the atlas.
 
@@ -607,19 +604,21 @@ def resize(self, size: Tuple[int, int]) -> None:
         undefined state.
 
         :param size: The new size
+        :param force: Force a resize even if the size is the same
         """
         LOG.info("[%s] Resizing atlas from %s to %s", id(self), self._size, size)
         # print("Resizing atlas from", self._size, "to", size)
 
         # Only resize if the size actually changed
-        if size == self._size:
+        if size == self._size and not force:
             return
 
         self._check_size(size)
         resize_start = time.perf_counter()
 
         # Keep a reference to the old atlas texture so we can copy it into the new one
         atlas_texture_old = self._texture
+        atlas_texture_old.filter = self._ctx.NEAREST, self._ctx.NEAREST
         self._size = size
 
         # Create new image uv data temporarily keeping the old one
@@ -729,7 +728,7 @@ def use_uv_texture(self, unit: int = 0) -> None:
     def render_into(
         self,
         texture: "Texture",
-        projection: Optional[Tuple[float, float, float, float]] = None,
+        projection: Optional[tuple[float, float, float, float]] = None,
     ):
         """
         Render directly into a sub-section of the atlas.
@@ -812,7 +811,7 @@ def to_image(
         flip: bool = False,
         components: int = 4,
         draw_borders: bool = False,
-        border_color: Tuple[int, int, int] = (255, 0, 0),
+        border_color: tuple[int, int, int] = (255, 0, 0),
     ) -> Image.Image:
         """
         Convert the atlas to a Pillow image.
@@ -854,7 +853,7 @@ def show(
         flip: bool = False,
         components: int = 4,
         draw_borders: bool = False,
-        border_color: Tuple[int, int, int] = (255, 0, 0),
+        border_color: tuple[int, int, int] = (255, 0, 0),
     ) -> None:
         """
         Show the texture atlas using Pillow.
@@ -880,7 +879,7 @@ def save(
         flip: bool = False,
         components: int = 4,
         draw_borders: bool = False,
-        border_color: Tuple[int, int, int] = (255, 0, 0),
+        border_color: tuple[int, int, int] = (255, 0, 0),
     ) -> None:
         """
         Save the texture atlas to a png.
@@ -901,7 +900,7 @@ def save(
             border_color=border_color,
         ).save(path, format="png")
 
-    def _check_size(self, size: Tuple[int, int]) -> None:
+    def _check_size(self, size: tuple[int, int]) -> None:
         """Check it the atlas exceeds the hardware limitations"""
         if size[0] > self._max_size[0] or size[1] > self._max_size[1]:
             raise Exception(