Add support for creating plain SDL windows and renderers.

Author: HexDecimal

.vscode/settings.json

@@ -220,6 +220,7 @@
         "pcpp",
         "PILCROW",
         "pilmode",
+        "PRESENTVSYNC",
         "PRINTF",
         "printn",
         "pycall",

tcod/sdl/__init__.py

@@ -35,4 +35,11 @@ def _check(result: int) -> int:
     return result
 
 
+def _check_p(result: Any) -> Any:
+    """Check if an SDL function returned NULL, and raise an exception if it did."""
+    if not result:
+        raise RuntimeError(_get_error())
+    return result
+
+
 lib.SDL_LogSetOutputFunction(lib._sdl_log_output_function, ffi.NULL)

tcod/sdl/render.py

@@ -5,8 +5,9 @@
 import numpy as np
 from numpy.typing import NDArray
 
+import tcod.sdl.video
 from tcod.loader import ffi, lib
-from tcod.sdl import _check
+from tcod.sdl import _check, _check_p
 
 
 class Texture:
@@ -161,3 +162,34 @@ def upload_texture(
             lib.SDL_UpdateTexture(texture.p, ffi.NULL, ffi.cast("const void*", pixels.ctypes.data), pixels.strides[0])
         )
         return texture
+
+
+def new_renderer(
+    window: tcod.sdl.video.Window,
+    *,
+    driver: Optional[int] = None,
+    software: bool = False,
+    vsync: bool = True,
+    target_textures: bool = False,
+) -> Renderer:
+    """Initialize and return a new SDL Renderer.
+
+    Example::
+
+        # Start by creating a window.
+        sdl_window = tcod.sdl.video.new_window(640, 480)
+        # Create a renderer with target texture support.
+        sdl_renderer = tcod.sdl.render.new_renderer(sdl_window, target_textures=True)
+
+    .. seealso::
+        :func:`tcod.sdl.video.new_window`
+    """
+    driver = driver if driver is not None else -1
+    flags = 0
+    if vsync:
+        flags |= int(lib.SDL_RENDERER_PRESENTVSYNC)
+    if target_textures:
+        flags |= int(lib.SDL_RENDERER_TARGETTEXTURE)
+    flags |= int(lib.SDL_RENDERER_SOFTWARE) if software else int(lib.SDL_RENDERER_ACCELERATED)
+    renderer_p = _check_p(ffi.gc(lib.SDL_CreateRenderer(window.p, driver, flags), lib.SDL_DestroyRenderer))
+    return Renderer(renderer_p)

tcod/sdl/video.py

@@ -5,12 +5,14 @@
 """
 from __future__ import annotations
 
-from typing import Any, Tuple
+import sys
+from typing import Any, Optional, Tuple
 
 import numpy as np
 from numpy.typing import ArrayLike, NDArray
 
 from tcod.loader import ffi, lib
+from tcod.sdl import _check_p
 
 __all__ = ("Window",)
 
@@ -124,6 +126,33 @@ def title(self, value: str) -> None:
         lib.SDL_SetWindowtitle(self.p, value.encode("utf-8"))
 
 
+def new_window(
+    width: int,
+    height: int,
+    *,
+    x: Optional[int] = None,
+    y: Optional[int] = None,
+    title: Optional[str] = None,
+    flags: int = 0,
+) -> Window:
+    """Initialize and return a new SDL Window.
+
+    Example::
+
+        # Create a new resizable window with a custom title.
+        window = tcod.sdl.video.new_window(640, 480, title="Title bar text", flags=tcod.lib.SDL_WINDOW_RESIZABLE)
+
+    .. seealso::
+        :func:`tcod.sdl.render.new_renderer`
+    """
+    x = x if x is not None else int(lib.SDL_WINDOWPOS_UNDEFINED)
+    y = y if y is not None else int(lib.SDL_WINDOWPOS_UNDEFINED)
+    if title is None:
+        title = sys.argv[0]
+    window_p = ffi.gc(lib.SDL_CreateWindow(title.encode("utf-8"), x, y, width, height, flags), lib.SDL_DestroyWindow)
+    return Window(_check_p(window_p))
+
+
 def _get_active_window() -> Window:
     """Return the SDL2 window current managed by libtcod.