Add some SDL modules to the documentation.

Author: HexDecimal

docs/index.rst

@@ -36,8 +36,11 @@ Contents:
     tcod/noise
     tcod/path
     tcod/random
+    tcod/render
     tcod/tileset
     libtcodpy
+    sdl/render
+    sdl/video
 
 Indices and tables
 ==================

docs/sdl/render.rst

@@ -0,0 +1,5 @@
+tcod.sdl.render - SDL Rendering
+===============================
+
+.. automodule:: tcod.sdl.render
+    :members:

docs/sdl/video.rst

@@ -0,0 +1,5 @@
+tcod.sdl.video - SDL Window and Display API
+===========================================
+
+.. automodule:: tcod.sdl.video
+    :members:

docs/tcod/render.rst

@@ -0,0 +1,5 @@
+tcod.render - Console Rendering Extension
+=========================================
+
+.. automodule:: tcod.render
+    :members:

tcod/render.py

@@ -1,4 +1,8 @@
-"""Handle the rendering of libtcod's tilesets.
+"""Handles the rendering of libtcod's tilesets.
+
+Using this module you can render a console to an SDL :any:`Texture` directly, letting you have full control over how
+conoles are displayed.
+This includes rendering multiple tilesets in a single frame and rendering consoles on top of each other.
 
 Example::
 
@@ -19,6 +23,8 @@
         for event in tcod.event.wait():
             if isinstance(event, tcod.event.Quit):
                 raise SystemExit()
+
+.. versionadded:: 13.4
 """
 
 from __future__ import annotations

tcod/sdl/render.py

@@ -1,3 +1,7 @@
+"""SDL2 Rendering functionality.
+
+.. versionadded:: 13.4
+"""
 from __future__ import annotations
 
 import enum
@@ -23,6 +27,8 @@ class TextureAccess(enum.IntEnum):
 
 
 class Texture:
+    """SDL hardware textures."""
+
     def __init__(self, sdl_texture_p: Any, sdl_renderer_p: Any = None) -> None:
         self.p = sdl_texture_p
         self._sdl_renderer_p = sdl_renderer_p  # Keep alive.
@@ -114,6 +120,8 @@ def __exit__(self, *_: Any) -> None:
 
 
 class Renderer:
+    """SDL Renderer."""
+
     def __init__(self, sdl_renderer_p: Any) -> None:
         if ffi.typeof(sdl_renderer_p) is not ffi.typeof("struct SDL_Renderer*"):
             raise TypeError(f"Expected a {ffi.typeof('struct SDL_Window*')} type (was {ffi.typeof(sdl_renderer_p)}).")

tcod/sdl/video.py

@@ -1,7 +1,6 @@
-"""SDL2 specific functionality.
+"""SDL2 Window and Display handling.
 
-Add the line ``import tcod.sdl`` to include this module, as importing this
-module is not implied by ``import tcod``.
+.. versionadded:: 13.4
 """
 from __future__ import annotations
 
@@ -33,33 +32,60 @@ class WindowFlags(enum.IntFlag):
     """
 
     FULLSCREEN = lib.SDL_WINDOW_FULLSCREEN or 0
+    """"""
     FULLSCREEN_DESKTOP = lib.SDL_WINDOW_FULLSCREEN_DESKTOP or 0
+    """"""
     OPENGL = lib.SDL_WINDOW_OPENGL or 0
+    """"""
     SHOWN = lib.SDL_WINDOW_SHOWN or 0
+    """"""
     HIDDEN = lib.SDL_WINDOW_HIDDEN or 0
+    """"""
     BORDERLESS = lib.SDL_WINDOW_BORDERLESS or 0
+    """"""
     RESIZABLE = lib.SDL_WINDOW_RESIZABLE or 0
+    """"""
     MINIMIZED = lib.SDL_WINDOW_MINIMIZED or 0
+    """"""
     MAXIMIZED = lib.SDL_WINDOW_MAXIMIZED or 0
+    """"""
     MOUSE_GRABBED = lib.SDL_WINDOW_INPUT_GRABBED or 0
+    """"""
     INPUT_FOCUS = lib.SDL_WINDOW_INPUT_FOCUS or 0
+    """"""
     MOUSE_FOCUS = lib.SDL_WINDOW_MOUSE_FOCUS or 0
+    """"""
     FOREIGN = lib.SDL_WINDOW_FOREIGN or 0
+    """"""
     ALLOW_HIGHDPI = lib.SDL_WINDOW_ALLOW_HIGHDPI or 0
+    """"""
     MOUSE_CAPTURE = lib.SDL_WINDOW_MOUSE_CAPTURE or 0
+    """"""
     ALWAYS_ON_TOP = lib.SDL_WINDOW_ALWAYS_ON_TOP or 0
+    """"""
     SKIP_TASKBAR = lib.SDL_WINDOW_SKIP_TASKBAR or 0
+    """"""
     UTILITY = lib.SDL_WINDOW_UTILITY or 0
+    """"""
     TOOLTIP = lib.SDL_WINDOW_TOOLTIP or 0
+    """"""
     POPUP_MENU = lib.SDL_WINDOW_POPUP_MENU or 0
+    """"""
     VULKAN = lib.SDL_WINDOW_VULKAN or 0
+    """"""
     METAL = getattr(lib, "SDL_WINDOW_METAL", None) or 0x20000000  # SDL >= 2.0.14
+    """"""
 
 
 class FlashOperation(enum.IntEnum):
+    """Values for :any:`Window.flash`."""
+
     CANCEL = 0
+    """Stop flashing."""
     BRIEFLY = 1
+    """Flash breifly."""
     UNTIL_FOCUSED = 2
+    """Flash until focus is gained."""
 
 
 class _TempSurface:
@@ -185,7 +211,7 @@ def flags(self) -> WindowFlags:
     def fullscreen(self) -> int:
         """Get or set the fullscreen status of this window.
 
-        Can be set to :any:`WindowFlags.FULLSCREEN` or :any:`WindowFlags.FULLSCREEN_DESKTOP` flags
+        Can be set to the :any:`WindowFlags.FULLSCREEN` or :any:`WindowFlags.FULLSCREEN_DESKTOP` flags.
 
         Example::
 
@@ -304,8 +330,9 @@ def new_window(
 
     Example::
 
+        import tcod.sdl.video
         # 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)
+        window = tcod.sdl.video.new_window(640, 480, title="Title bar text", flags=tcod.sdl.video.WindowFlags.RESIZABLE)
 
     .. seealso::
         :func:`tcod.sdl.render.new_renderer`