mini-arcade-native-backend 0.6.0__tar.gz → 1.0.0__tar.gz

{mini_arcade_native_backend-0.6.0 → mini_arcade_native_backend-1.0.0}/CHANGELOG.md

@@ -6,6 +6,15 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [1.0.0] - 2026-02-03
+
+### Changed
+- Add separation of concerns
+
+### Other
+- Merge release/0.6 into develop
+- Merge branch 'release/0.6' of https://github.com/alexsc6955/mini-arcade-native-backend into release/0.6
+
 ## [0.6.0] - 2026-01-23
 
 ### Added

mini_arcade_native_backend-1.0.0/CMakeLists.txt

@@ -0,0 +1,73 @@
+cmake_minimum_required(VERSION 3.16)
+
+# --- vcpkg toolchain auto-detect (must be BEFORE project()) ---
+if(NOT DEFINED CMAKE_TOOLCHAIN_FILE)
+    if(DEFINED ENV{VCPKG_ROOT})
+        set(_VCPKG_TOOLCHAIN "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
+        if(EXISTS "${_VCPKG_TOOLCHAIN}")
+            set(CMAKE_TOOLCHAIN_FILE "${_VCPKG_TOOLCHAIN}" CACHE FILEPATH "vcpkg toolchain" FORCE)
+        endif()
+    endif()
+endif()
+
+# If something set a broken toolchain like "/scripts/buildsystems/vcpkg.cmake", fix it
+if(DEFINED CMAKE_TOOLCHAIN_FILE AND CMAKE_TOOLCHAIN_FILE MATCHES "^/scripts/buildsystems/vcpkg.cmake$")
+    if(DEFINED ENV{VCPKG_ROOT})
+        set(_VCPKG_TOOLCHAIN "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake")
+        if(EXISTS "${_VCPKG_TOOLCHAIN}")
+            set(CMAKE_TOOLCHAIN_FILE "${_VCPKG_TOOLCHAIN}" CACHE FILEPATH "vcpkg toolchain" FORCE)
+        endif()
+    endif()
+endif()
+
+project(mini_arcade_native_backend LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Let vcpkg toolchain be used if user sets CMAKE_TOOLCHAIN_FILE env var.
+# (scikit-build-core will pass env vars to CMake.)
+
+find_package(pybind11 CONFIG REQUIRED)
+find_package(SDL2 CONFIG REQUIRED)
+find_package(SDL2_ttf CONFIG REQUIRED)
+find_package(SDL2_mixer CONFIG REQUIRED) 
+
+set(TARGET_NAME _native)
+
+set(NATIVE_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/src/native)
+set(NATIVE_INC  ${NATIVE_ROOT}/include)
+
+set(NATIVE_SOURCES
+    ${NATIVE_ROOT}/bindings.cpp
+    ${NATIVE_ROOT}/backend.cpp
+    ${NATIVE_ROOT}/platform.cpp
+    ${NATIVE_ROOT}/window.cpp
+    ${NATIVE_ROOT}/input.cpp
+    ${NATIVE_ROOT}/capture.cpp
+    ${NATIVE_ROOT}/audio.cpp
+    ${NATIVE_ROOT}/sdl_renderer.cpp
+    ${NATIVE_ROOT}/sdl_text.cpp
+)
+
+pybind11_add_module(${TARGET_NAME} ${NATIVE_SOURCES})
+
+target_include_directories(${TARGET_NAME}
+    PRIVATE
+        ${NATIVE_INC}
+)
+
+# # C++ sources live under cpp/
+# pybind11_add_module(${TARGET_NAME}
+#     cpp/bindings.cpp
+#     cpp/engine.cpp
+# )
+
+target_link_libraries(${TARGET_NAME} PRIVATE SDL2::SDL2 SDL2_ttf::SDL2_ttf SDL2_mixer::SDL2_mixer)
+
+# Install the compiled extension into the Python package directory
+# so it ends up as mini_arcade_native_backend/_native.*.pyd
+install(TARGETS ${TARGET_NAME}
+        LIBRARY DESTINATION mini_arcade_native_backend
+        RUNTIME DESTINATION mini_arcade_native_backend
+        ARCHIVE DESTINATION mini_arcade_native_backend)

{mini_arcade_native_backend-0.6.0 → mini_arcade_native_backend-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: mini-arcade-native-backend
-Version: 0.6.0
+Version: 1.0.0
 Summary: Native SDL2 backend for mini-arcade-core using SDL2 + pybind11.
 Author-Email: Santiago Rincon <rincores@gmail.com>
 License: Copyright (c) 2025 Santiago Rincón
@@ -295,14 +295,14 @@ from mini_arcade_core.backend import Backend, Event, EventType
 from mini_arcade_native_backend import NativeBackend
 
 class MyScene(Scene):
-    def handle_event(self, event: Event) -> None:
+    def handle_event(self, event: Event):
         if event.type == EventType.KEYDOWN and event.key == 27:  # ESC
             self.game.quit()
 
-    def update(self, dt: float) -> None:
+    def update(self, dt: float):
         ...
 
-    def draw(self, backend: Backend) -> None:
+    def draw(self, backend: Backend):
         backend.draw_rect(100, 100, 200, 150)
 
 config = GameConfig(

{mini_arcade_native_backend-0.6.0 → mini_arcade_native_backend-1.0.0}/README.md

@@ -259,14 +259,14 @@ from mini_arcade_core.backend import Backend, Event, EventType
 from mini_arcade_native_backend import NativeBackend
 
 class MyScene(Scene):
-    def handle_event(self, event: Event) -> None:
+    def handle_event(self, event: Event):
         if event.type == EventType.KEYDOWN and event.key == 27:  # ESC
             self.game.quit()
 
-    def update(self, dt: float) -> None:
+    def update(self, dt: float):
         ...
 
-    def draw(self, backend: Backend) -> None:
+    def draw(self, backend: Backend):
         backend.draw_rect(100, 100, 200, 150)
 
 config = GameConfig(

{mini_arcade_native_backend-0.6.0 → mini_arcade_native_backend-1.0.0}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "mini-arcade-native-backend"
-version = "0.6.0"
+version = "1.0.0"
 description = "Native SDL2 backend for mini-arcade-core using SDL2 + pybind11."
 authors = [
   { name = "Santiago Rincon", email = "rincores@gmail.com" },

mini_arcade_native_backend-1.0.0/src/mini_arcade_native_backend/__init__.py

@@ -0,0 +1,60 @@
+"""
+mini-arcade native backend package.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from .dlls import setup_windows_dll_search_paths
+
+setup_windows_dll_search_paths()
+
+if TYPE_CHECKING:
+    # Justification: Need to import core after setting DLL path on Windows
+    # pylint: disable=wrong-import-position
+    from .config import (
+        AudioSettings,
+        BackendSettings,
+        FontSettings,
+        RendererSettings,
+        WindowSettings,
+    )
+    from .native_backend import NativeBackend
+
+__all__ = [
+    "NativeBackend",
+    "BackendSettings",
+    "WindowSettings",
+    "RendererSettings",
+    "FontSettings",
+    "AudioSettings",
+]
+
+
+# NOTE: Momentary __getattr__ to avoid circular imports for type hints
+# pylint: disable=import-outside-toplevel,possibly-unused-variable
+def __getattr__(name: str):
+    if name == "NativeBackend":
+        from .native_backend import NativeBackend
+
+        return NativeBackend
+
+    if name in {
+        "AudioSettings",
+        "BackendSettings",
+        "FontSettings",
+        "RendererSettings",
+        "WindowSettings",
+    }:
+        from .config import (
+            AudioSettings,
+            BackendSettings,
+            FontSettings,
+            RendererSettings,
+            WindowSettings,
+        )
+
+        return locals()[name]
+
+    raise AttributeError(name)

mini_arcade_native_backend-1.0.0/src/mini_arcade_native_backend/_native.pyi

@@ -0,0 +1,441 @@
+"""
+Type stubs for the native backend module.
+"""
+
+from __future__ import annotations
+
+from enum import IntEnum
+from typing import Dict, Tuple
+
+# Justification: Some methods have many arguments for configuration purposes.
+# pylint: disable=too-many-positional-arguments,too-many-arguments
+
+# Justification: 'id' and 'type' are commonly used names in this context.
+# pylint: disable=redefined-builtin
+
+# Justification: Enum members use PascalCase by convention.
+# pylint: disable=invalid-name
+
+class EventType(IntEnum):
+    """Enumeration of event types."""
+
+    Unknown = 0
+    Quit = 1
+    KeyDown = 2
+    KeyUp = 3
+    MouseMotion = 4
+    MouseButtonDown = 5
+    MouseButtonUp = 6
+    MouseWheel = 7
+    WindowResized = 8
+    TextInput = 9
+
+class RenderAPI(IntEnum):
+    """Enumeration of rendering APIs."""
+
+    SDL2 = 0
+    OpenGL = 1
+
+class Event:
+    """
+    Representation of a native event.
+
+    :ivar type (EventType): The type of the event.
+    :ivar key (int): Key code for keyboard events.
+    :ivar scancode (int): Scancode for keyboard events.
+    :ivar mod (int): Modifier keys state.
+    :ivar repeat (int): Repeat count for keyboard events.
+    :ivar x (int): X coordinate for mouse events.
+    :ivar y (int): Y coordinate for mouse events.
+    :ivar dx (int): Change in X for mouse motion events.
+    :ivar dy (int): Change in Y
+    :ivar button (int): Mouse button for mouse button events.
+    :ivar wheel_x (int): Wheel movement in X direction.
+    :ivar wheel_y (int): Wheel movement in Y direction.
+    :ivar width (int): Width for window resize events.
+    :ivar height (int): Height for window resize events.
+    :ivar text (str): Text input for text input events.
+    """
+
+    type: EventType
+    key: int
+    scancode: int
+    mod: int
+    repeat: int
+    x: int
+    y: int
+    dx: int
+    dy: int
+    button: int
+    wheel_x: int
+    wheel_y: int
+    width: int
+    height: int
+    text: str
+
+class ColorRGBA:
+    """
+    Representation of an RGBA color.
+
+    :ivar r (int): Red component (0-255).
+    :ivar g (int): Green component (0-255).
+    :ivar b (int): Blue component (0-255).
+    :ivar a (int): Alpha component (0-255).
+    """
+
+    r: int
+    g: int
+    b: int
+    a: int
+
+class WindowConfig:
+    """
+    Configuration for the application window.
+
+    :ivar width (int): Width of the window.
+    :ivar height (int): Height of the window.
+    :ivar title (str): Title of the window.
+    :ivar resizable (bool): Whether the window is resizable.
+    :ivar high_dpi (bool): Whether to enable high DPI support.
+    """
+
+    width: int
+    height: int
+    title: str
+    resizable: bool
+    high_dpi: bool
+
+class RenderConfig:
+    """
+    Configuration for the rendering system.
+
+    :ivar api (RenderAPI): The rendering API to use.
+    """
+
+    api: RenderAPI
+    clear_color: ColorRGBA
+
+class TextConfig:
+    """
+    Configuration for the text rendering system.
+
+    :ivar default_font_path (str): Path to the default font.
+    :ivar default_font_size (int): Size of the default font.
+    """
+
+    default_font_path: str
+    default_font_size: int
+
+class AudioConfig:
+    """
+    Configuration for the audio system.
+
+    :ivar enabled (bool): Whether audio is enabled.
+    :ivar frequency (int): Audio frequency.
+    :ivar channels (int): Number of audio channels.
+    :ivar chunk_size (int): Size of audio chunks.
+    """
+
+    enabled: bool
+    frequency: int
+    channels: int
+    chunk_size: int
+
+class BackendConfig:
+    """
+    Configuration for the native backend.
+
+    :ivar window (WindowConfig): Window configuration.
+    :ivar render (RenderConfig): Render configuration.
+    :ivar text (TextConfig): Text configuration.
+    :ivar audio (AudioConfig): Audio configuration.
+    :ivar sounds (Dict[str, str]): Mapping of sound IDs to file paths.
+    """
+
+    window: WindowConfig
+    render: RenderConfig
+    text: TextConfig
+    audio: AudioConfig
+    sounds: Dict[str, str]
+
+class Window:
+    """
+    Window management class.
+    """
+
+    def set_title(self, title: str):
+        """
+        Set the window title.
+
+        :param title: The new title for the window.
+        :type title: str
+        """
+
+    def resize(self, w: int, h: int):
+        """
+        Resize the window.
+
+        :param w: New width of the window.
+        :type w: int
+        :param h: New height of the window.
+        :type h: int
+        """
+
+    def size(self) -> Tuple[int, int]:
+        """
+        Get the current size of the window.
+
+        :return: A tuple containing the width and height of the window.
+        :rtype: Tuple[int, int]
+        """
+
+    def drawable_size(self) -> Tuple[int, int]:
+        """
+        Get the drawable size of the window.
+
+        :return: A tuple containing the drawable width and height of the window.
+        :rtype: Tuple[int, int]
+        """
+
+class Audio:
+    """
+    Audio management class.
+    """
+
+    def init(
+        self, frequency: int = 44100, channels: int = 2, chunk_size: int = 2048
+    ):
+        """
+        :param frequency: Audio frequency (default is 44100).
+        :type frequency: int
+        :param channels: Number of audio channels (default is 2).
+        :type channels: int
+        :param chunk_size: Size of audio chunks (default is 2048).
+        :type chunk_size: int
+        """
+
+    def shutdown(self):
+        """Shutdown the audio system."""
+
+    def load_sound(self, id: str, path: str):
+        """
+        Load a sound from the given file path.
+
+        :param id: Identifier for the sound.
+        :type id: str
+        :param path: File path to the sound.
+        :type path: str
+        """
+
+    def play_sound(self, id: str, loops: int = 0):
+        """
+        Play a sound by its identifier.
+
+        :param id: Identifier of the sound to play.
+        :type id: str
+        :param loops: Number of times to loop the sound (default is 0).
+        :type loops: int
+        """
+
+    def set_master_volume(self, volume: int):
+        """
+        Set the master volume for audio playback.
+
+        :param volume: Volume level (0-100).
+        :type volume: int
+        """
+
+    def set_sound_volume(self, id: str, volume: int):
+        """
+        Set the volume for a specific sound.
+
+        :param id: Identifier of the sound.
+        :type id: str
+        :param volume: Volume level (0-100).
+        :type volume: int
+        """
+
+    def stop_all(self):
+        """Stop all currently playing sounds."""
+
+class Backend:
+    """
+    Native backend class.
+
+    :ivar window (Window): Window management instance.
+    :ivar audio (Audio): Audio management instance.
+    """
+
+    window: Window
+    audio: Audio
+
+    def __init__(self, config: BackendConfig):
+        """
+        :param config: Configuration for the backend.
+        :type config: BackendConfig
+        """
+
+    def set_clear_color(self, r: int, g: int, b: int):
+        """
+        Set the clear color for rendering.
+
+        :param r: Red component (0-255).
+        :type r: int
+        :param g: Green component (0-255).
+        :type g: int
+        :param b: Blue component (0-255).
+        :type b: int
+        """
+
+    def begin_frame(self):
+        """Begin a new rendering frame."""
+
+    def end_frame(self):
+        """End the current rendering frame."""
+
+    def draw_rect(
+        self, x: int, y: int, w: int, h: int, r: int, g: int, b: int, a: int
+    ):
+        """
+        Draw a rectangle.
+
+        :param x: X coordinate of the rectangle.
+        :type x: int
+        :param y: Y coordinate of the rectangle.
+        :type y: int
+        :param w: Width of the rectangle.
+        :type w: int
+        :param h: Height of the rectangle.
+        :type h: int
+        :param r: Red component (0-255).
+        :type r: int
+        :param g: Green component (0-255).
+        :type g: int
+        :param b: Blue component (0-255).
+        :type b: int
+        :param a: Alpha component (0-255).
+        :type a: int
+        """
+
+    def draw_line(
+        self,
+        x1: int,
+        y1: int,
+        x2: int,
+        y2: int,
+        r: int,
+        g: int,
+        b: int,
+        a: int,
+    ):
+        """
+        Draw a line.
+
+        :param x1: X coordinate of the start point.
+        :type x1: int
+        :param y1: Y coordinate of the start point.
+        :type y1: int
+        :param x2: X coordinate of the end point.
+        :type x2: int
+        :param y2: Y coordinate of the end point.
+        :type y2: int
+        :param r: Red component (0-255).
+        :type r: int
+        :param g: Green component (0-255).
+        :type g: int
+        :param b: Blue component (0-255).
+        :type b: int
+        :param a: Alpha component (0-255).
+        :type a: int
+        """
+
+    def set_clip_rect(self, x: int, y: int, w: int, h: int):
+        """
+        Set the clipping rectangle for rendering.
+
+        :param x: X coordinate of the clipping rectangle.
+        :type x: int
+        :param y: Y coordinate of the clipping rectangle.
+        :type y: int
+        :param w: Width of the clipping rectangle.
+        :type w: int
+        :param h: Height of the clipping rectangle.
+        :type h: int
+        """
+
+    def clear_clip_rect(self):
+        """Clear the clipping rectangle."""
+
+    def load_font(self, path: str, pt: int) -> int:
+        """
+        Load a font from the given file path.
+
+        :param path: File path to the font.
+        :type path: str
+        :param pt: Point size of the font.
+        :type pt: int
+        :return: Font identifier.
+        :rtype: int
+        """
+
+    def measure_text(self, text: str, font_id: int = -1) -> Tuple[int, int]:
+        """
+        Measure the dimensions of the given text.
+
+        :param text: The text to measure.
+        :type text: str
+        :param font_id: Identifier of the font to use (default is -1 for default font).
+        :type font_id: int
+        :return: A tuple containing the width and height of the text.
+        :rtype: Tuple[int, int]
+        """
+
+    def draw_text(
+        self,
+        text: str,
+        x: int,
+        y: int,
+        r: int,
+        g: int,
+        b: int,
+        a: int,
+        font_id: int = -1,
+    ):
+        """
+        Draw text at the specified position.
+
+        :param text: The text to draw.
+        :type text: str
+        :param x: X coordinate for the text.
+        :type x: int
+        :param y: Y coordinate for the text.
+        :type y: int
+        :param r: Red component (0-255).
+        :type r: int
+        :param g: Green component (0-255).
+        :type g: int
+        :param b: Blue component (0-255).
+        :type b: int
+        :param a: Alpha component (0-255).
+        :type a: int
+        :param font_id: Identifier of the font to use (default is -1 for default font).
+        :type font_id: int
+        """
+
+    def poll_events(self) -> list[Event]:
+        """
+        Poll for native events.
+
+        :return: A list of polled events.
+        :rtype: list[Event]
+        """
+
+    def capture_bmp(self, path: str) -> bool:
+        """
+        Capture the current frame buffer to a BMP file.
+
+        :param path: File path to save the BMP image.
+        :type path: str
+        :return: True if the capture was successful, False otherwise.
+        :rtype: bool
+        """