Prepare 19.0.0 release.

Author: HexDecimal

CHANGELOG.md

@@ -6,6 +6,11 @@ This project adheres to [Semantic Versioning](https://semver.org/) since version
 
 ## [Unreleased]
 
+## [19.0.0] - 2025-06-13
+
+Finished port to SDL3, this has caused several breaking changes from SDL such as lowercase key constants now being uppercase and mouse events returning `float` instead of `int`.
+Be sure to run [Mypy](https://mypy.readthedocs.io/en/stable/getting_started.html) on your projects to catch any issues from this update.
+
 ### Changed
 
 - Updated libtcod to 2.1.1

tcod/sdl/audio.py

@@ -217,7 +217,7 @@ class AudioDevice:
     .. versionchanged:: 16.0
         Can now be used as a context which will close the device on exit.
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         Removed `spec` and `callback` attribute.
 
         `queued_samples`, `queue_audio`, and `dequeue_audio` moved to :any:`AudioStream` class.
@@ -269,7 +269,7 @@ def __init__(
         self.is_physical: Final[bool] = bool(lib.SDL_IsAudioDevicePhysical(device_id))
         """True of this is a physical device, or False if this is a logical device.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
 
     def __repr__(self) -> str:
@@ -294,7 +294,7 @@ def __repr__(self) -> str:
     def name(self) -> str:
         """Name of the device.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         return str(ffi.string(_check_p(lib.SDL_GetAudioDeviceName(self.device_id))), encoding="utf-8")
 
@@ -304,7 +304,7 @@ def gain(self) -> float:
 
         Default is 1.0 but can be set higher or zero.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         return _check_float(lib.SDL_GetAudioDeviceGain(self.device_id), failure=-1.0)
 
@@ -320,7 +320,7 @@ def open(
     ) -> Self:
         """Open a new logical audio device for this device.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
 
         .. seealso::
             https://wiki.libsdl.org/SDL3/SDL_OpenAudioDevice
@@ -349,7 +349,7 @@ def _sample_size(self) -> int:
     def stopped(self) -> bool:
         """Is True if the device has failed or was closed.
 
-        .. deprecated:: Unreleased
+        .. deprecated:: 19.0
             No longer used by the SDL3 API.
         """
         return bool(not hasattr(self, "device_id"))
@@ -417,7 +417,7 @@ def close(self) -> None:
     def __enter__(self) -> Self:
         """Return self and enter a managed context.
 
-        .. deprecated:: Unreleased
+        .. deprecated:: 19.0
             Use :func:`contextlib.closing` if you want to close this device after a context.
         """
         return self
@@ -443,7 +443,7 @@ def new_stream(
     ) -> AudioStream:
         """Create, bind, and return a new :any:`AudioStream` for this device.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         new_stream = AudioStream.new(format=format, channels=channels, frequency=frequency)
         self.bind((new_stream,))
@@ -463,7 +463,7 @@ def bind(self, streams: Iterable[AudioStream], /) -> None:
 class AudioStreamCallbackData:
     """Data provided to AudioStream callbacks.
 
-    .. versionadded:: Unreleased
+    .. versionadded:: 19.0
     """
 
     additional_bytes: int
@@ -487,7 +487,7 @@ class AudioStream:
 
     This class is commonly created with :any:`AudioDevice.new_stream` which creates a new stream bound to the device.
 
-    ..versionadded:: Unreleased
+    ..versionadded:: 19.0
     """
 
     __slots__ = ("__weakref__", "_stream_p")
@@ -819,10 +819,10 @@ class BasicMixer:
 
     .. versionadded:: 13.6
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         Added `frequency` and `channels` parameters.
 
-    .. deprecated:: Unreleased
+    .. deprecated:: 19.0
         Changes in the SDL3 API have made this classes usefulness questionable.
         This class should be replaced with custom streams.
     """
@@ -927,7 +927,7 @@ def _sdl_audio_stream_callback(userdata: Any, stream_p: Any, additional_amount:
 def get_devices() -> dict[str, AudioDevice]:
     """Iterate over the available audio output devices.
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         Now returns a dictionary of :any:`AudioDevice`.
     """
     tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.AUDIO)
@@ -942,7 +942,7 @@ def get_devices() -> dict[str, AudioDevice]:
 def get_capture_devices() -> dict[str, AudioDevice]:
     """Iterate over the available audio capture devices.
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         Now returns a dictionary of :any:`AudioDevice`.
     """
     tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.AUDIO)
@@ -960,7 +960,7 @@ def get_default_playback() -> AudioDevice:
     Example:
         playback_device = tcod.sdl.audio.get_default_playback().open()
 
-    .. versionadded:: Unreleased
+    .. versionadded:: 19.0
     """
     tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.AUDIO)
     return AudioDevice(ffi.cast("SDL_AudioDeviceID", lib.SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK))
@@ -972,7 +972,7 @@ def get_default_recording() -> AudioDevice:
     Example:
         recording_device = tcod.sdl.audio.get_default_recording().open()
 
-    .. versionadded:: Unreleased
+    .. versionadded:: 19.0
     """
     tcod.sdl.sys.init(tcod.sdl.sys.Subsystem.AUDIO)
     return AudioDevice(ffi.cast("SDL_AudioDeviceID", lib.SDL_AUDIO_DEVICE_DEFAULT_RECORDING))
@@ -982,7 +982,7 @@ def get_default_recording() -> AudioDevice:
 class AllowedChanges(enum.IntFlag):
     """Which parameters are allowed to be changed when the values given are not supported.
 
-    .. deprecated:: Unreleased
+    .. deprecated:: 19.0
         This is no longer used.
     """
 
@@ -1033,12 +1033,12 @@ def open(  # noqa: A001, PLR0913
     If a callback is given then it will be called with the `AudioDevice` and a Numpy buffer of the data stream.
     This callback will be run on a separate thread.
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         SDL3 returns audio devices differently, exact formatting is set with :any:`AudioDevice.new_stream` instead.
 
         `samples` and `allowed_changes` are ignored.
 
-    .. deprecated:: Unreleased
+    .. deprecated:: 19.0
         This is an outdated method.
         Use :any:`AudioDevice.open` instead, for example:
         ``tcod.sdl.audio.get_default_playback().open()``

tcod/sdl/mouse.py

@@ -183,7 +183,7 @@ def set_relative_mode(enable: bool) -> None:
         :any:`tcod.sdl.mouse.capture`
         https://wiki.libsdl.org/SDL_SetWindowRelativeMouseMode
 
-    .. deprecated:: Unreleased
+    .. deprecated:: 19.0
         Replaced with :any:`tcod.sdl.video.Window.relative_mouse_mode`
     """
     _check(lib.SDL_SetWindowRelativeMouseMode(lib.SDL_GetMouseFocus(), enable))
@@ -193,7 +193,7 @@ def set_relative_mode(enable: bool) -> None:
 def get_relative_mode() -> bool:
     """Return True if relative mouse mode is enabled.
 
-    .. deprecated:: Unreleased
+    .. deprecated:: 19.0
         Replaced with :any:`tcod.sdl.video.Window.relative_mouse_mode`
     """
     return bool(lib.SDL_GetWindowRelativeMouseMode(lib.SDL_GetMouseFocus()))

tcod/sdl/render.py

@@ -48,7 +48,7 @@ class LogicalPresentation(enum.IntEnum):
 
     See https://wiki.libsdl.org/SDL3/SDL_RendererLogicalPresentation
 
-    .. versionadded:: Unreleased
+    .. versionadded:: 19.0
     """
 
     DISABLED = 0
@@ -439,7 +439,7 @@ def set_logical_presentation(self, resolution: tuple[int, int], mode: LogicalPre
         .. seealso::
             https://wiki.libsdl.org/SDL3/SDL_SetRenderLogicalPresentation
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         width, height = resolution
         _check(lib.SDL_SetRenderLogicalPresentation(self.p, width, height, mode))
@@ -455,7 +455,7 @@ def logical_size(self) -> tuple[int, int]:
 
         .. versionadded:: 13.5
 
-        .. versionchanged:: Unreleased
+        .. versionchanged:: 19.0
             Setter is deprecated, use :any:`set_logical_presentation` instead.
         """
         out = ffi.new("int[2]")
@@ -537,7 +537,7 @@ def read_pixels(
 
         .. versionadded:: 15.0
 
-        .. versionchanged:: Unreleased
+        .. versionchanged:: 19.0
             `format` no longer accepts `int` values.
         """
         surface = _check_p(
@@ -681,7 +681,7 @@ def geometry(
 
         .. versionadded:: 13.5
 
-        .. versionchanged:: Unreleased
+        .. versionchanged:: 19.0
             `color` now takes float values instead of 8-bit integers.
         """
         xy = np.ascontiguousarray(xy, np.float32)
@@ -741,7 +741,7 @@ def new_renderer(
     .. seealso::
         :func:`tcod.sdl.video.new_window`
 
-    .. versionchanged:: Unreleased
+    .. versionchanged:: 19.0
         Removed `software` and `target_textures` parameters.
         `vsync` now takes an integer.
         `driver` now take a string.

tcod/sdl/video.py

@@ -276,7 +276,7 @@ def opacity(self, value: float) -> None:
     def grab(self) -> bool:
         """Get or set this windows input grab mode.
 
-        .. deprecated:: Unreleased
+        .. deprecated:: 19.0
             This attribute as been split into :any:`mouse_grab` and :any:`keyboard_grab`.
         """
         return self.mouse_grab
@@ -289,7 +289,7 @@ def grab(self, value: bool) -> None:
     def mouse_grab(self) -> bool:
         """Get or set this windows mouse input grab mode.
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         return bool(lib.SDL_GetWindowMouseGrab(self.p))
 
@@ -303,7 +303,7 @@ def keyboard_grab(self) -> bool:
 
         https://wiki.libsdl.org/SDL3/SDL_SetWindowKeyboardGrab
 
-        .. versionadded:: Unreleased
+        .. versionadded:: 19.0
         """
         return bool(lib.SDL_GetWindowKeyboardGrab(self.p))