kraken-engine 1.0.0__cp314-cp314-macosx_11_0_arm64.whl

pykraken/_core/transform.pyi

@@ -0,0 +1,141 @@
+"""
+Functions for transforming pixel arrays
+"""
+from __future__ import annotations
+import pykraken._core
+import typing
+__all__: list[str] = ['box_blur', 'flip', 'gaussian_blur', 'grayscale', 'invert', 'rotate', 'scale_by', 'scale_to']
+def box_blur(pixel_array: pykraken._core.PixelArray, radius: typing.SupportsInt, repeat_edge_pixels: bool = True) -> pykraken._core.PixelArray:
+    """
+    Apply a box blur effect to a pixel array.
+    
+    Box blur creates a uniform blur effect by averaging pixels within a square kernel.
+    It's faster than Gaussian blur but produces a more uniform, less natural look.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to blur.
+        radius (int): The blur radius in pixels. Larger values create stronger blur.
+        repeat_edge_pixels (bool, optional): Whether to repeat edge pixels when sampling
+                                            outside the pixel array bounds. Defaults to True.
+    
+    Returns:
+        PixelArray: A new pixel array with the box blur effect applied.
+    
+    Raises:
+        RuntimeError: If pixel array creation fails during the blur process.
+    """
+def flip(pixel_array: pykraken._core.PixelArray, flip_x: bool, flip_y: bool) -> pykraken._core.PixelArray:
+    """
+    Flip a pixel array horizontally, vertically, or both.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to flip.
+        flip_x (bool): Whether to flip horizontally (mirror left-right).
+        flip_y (bool): Whether to flip vertically (mirror top-bottom).
+    
+    Returns:
+        PixelArray: A new pixel array with the flipped image.
+    
+    Raises:
+        RuntimeError: If pixel array creation fails.
+    """
+def gaussian_blur(pixel_array: pykraken._core.PixelArray, radius: typing.SupportsInt, repeat_edge_pixels: bool = True) -> pykraken._core.PixelArray:
+    """
+    Apply a Gaussian blur effect to a pixel array.
+    
+    Gaussian blur creates a natural, smooth blur effect using a Gaussian distribution
+    for pixel weighting. It produces higher quality results than box blur but is
+    computationally more expensive.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to blur.
+        radius (int): The blur radius in pixels. Larger values create stronger blur.
+        repeat_edge_pixels (bool, optional): Whether to repeat edge pixels when sampling
+                                            outside the pixel array bounds. Defaults to True.
+    
+    Returns:
+        PixelArray: A new pixel array with the Gaussian blur effect applied.
+    
+    Raises:
+        RuntimeError: If pixel array creation fails during the blur process.
+    """
+def grayscale(pixel_array: pykraken._core.PixelArray) -> pykraken._core.PixelArray:
+    """
+    Convert a pixel array to grayscale.
+    
+    Converts the pixel array to grayscale using the standard luminance formula:
+    gray = 0.299 * red + 0.587 * green + 0.114 * blue
+    
+    This formula accounts for human perception of brightness across different colors.
+    The alpha channel is preserved unchanged.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to convert to grayscale.
+    
+    Returns:
+        PixelArray: A new pixel array converted to grayscale.
+    
+    Raises:
+        RuntimeError: If pixel array creation fails.
+    """
+def invert(pixel_array: pykraken._core.PixelArray) -> pykraken._core.PixelArray:
+    """
+    Invert the colors of a pixel array.
+    
+    Creates a negative image effect by inverting each color channel (RGB).
+    The alpha channel is preserved unchanged.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to invert.
+    
+    Returns:
+        PixelArray: A new pixel array with inverted colors.
+    
+    Raises:
+        RuntimeError: If pixel array creation fails.
+    """
+def rotate(pixel_array: pykraken._core.PixelArray, angle: typing.SupportsFloat) -> pykraken._core.PixelArray:
+    """
+    Rotate a pixel array by a given angle.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to rotate.
+        angle (float): The rotation angle in degrees. Positive values rotate clockwise.
+    
+    Returns:
+        PixelArray: A new pixel array containing the rotated image. The output pixel array may be
+                larger than the input to accommodate the rotated image.
+    
+    Raises:
+        RuntimeError: If pixel array rotation fails.
+    """
+def scale_by(pixel_array: pykraken._core.PixelArray, factor: typing.SupportsFloat) -> pykraken._core.PixelArray:
+    """
+    Scale a pixel array by a given factor.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to scale.
+        factor (float): The scaling factor (must be > 0). Values > 1.0 enlarge,
+                       values < 1.0 shrink the pixel array.
+    
+    Returns:
+        PixelArray: A new pixel array scaled by the specified factor.
+    
+    Raises:
+        ValueError: If factor is <= 0.
+        RuntimeError: If pixel array creation or scaling fails.
+    """
+def scale_to(pixel_array: pykraken._core.PixelArray, size: pykraken._core.Vec2) -> pykraken._core.PixelArray:
+    """
+    Scale a pixel array to a new exact size.
+    
+    Args:
+        pixel_array (PixelArray): The pixel array to scale.
+        size (Vec2): The target size as (width, height).
+    
+    Returns:
+        PixelArray: A new pixel array scaled to the specified size.
+    
+    Raises:
+        RuntimeError: If pixel array creation or scaling fails.
+    """

pykraken/_core/window.pyi

@@ -0,0 +1,113 @@
+"""
+Window related functions
+"""
+from __future__ import annotations
+import pykraken._core
+__all__: list[str] = ['close', 'create', 'get_scale', 'get_size', 'get_title', 'is_fullscreen', 'is_open', 'save_screenshot', 'set_fullscreen', 'set_icon', 'set_title']
+def close() -> None:
+    """
+    Close the window.
+    
+    Marks the window as closed, typically used to signal the main loop to exit.
+    This doesn't destroy the window immediately but sets the close flag.
+    """
+def create(title: str, resolution: pykraken._core.Vec2, scaled: bool = False) -> None:
+    """
+    Create a window with specified title and size.
+    
+    Args:
+        title (str): The window title. Must be non-empty and <= 255 characters.
+        resolution (Vec2): The renderer resolution as (width, height).
+        scaled (bool, optional): If True, creates a scaled up window using the
+                                display's usable bounds, retaining the resolution's ratio.
+                                Defaults to False.
+    
+    Raises:
+        RuntimeError: If a window already exists or window creation fails.
+        ValueError: If title is empty, exceeds 255 characters, or size values are <= 0.
+    """
+def get_scale() -> int:
+    """
+    Get the scale of the window relative to the renderer resolution.
+    
+    Returns:
+        int: The window's scale
+    
+    Raises:
+        RuntimeError: If the window is not initialized.
+    """
+def get_size() -> pykraken._core.Vec2:
+    """
+    Get the current size of the window.
+    
+    Returns:
+        tuple[float, float]: The window size as (width, height).
+    
+    Raises:
+        RuntimeError: If the window is not initialized.
+    """
+def get_title() -> str:
+    """
+    Get the current title of the window.
+    
+    Returns:
+        str: The current window title.
+    
+    Raises:
+        RuntimeError: If the window is not initialized.
+    """
+def is_fullscreen() -> bool:
+    """
+    Check if the window is in fullscreen mode.
+    
+    Returns:
+        bool: True if the window is currently in fullscreen mode.
+    
+    Raises:
+        RuntimeError: If the window is not initialized.
+    """
+def is_open() -> bool:
+    """
+    Check if the window is open.
+    
+    Returns:
+        bool: True if the window is open and active.
+    """
+def save_screenshot(path: str) -> None:
+    """
+    Save a screenshot of the current frame to a file.
+    
+    Args:
+        path (str): The path to save the screenshot to.
+    """
+def set_fullscreen(fullscreen: bool) -> None:
+    """
+    Set the fullscreen mode of the window.
+    
+    Args:
+        fullscreen (bool): True to enable fullscreen mode, False for windowed mode.
+    
+    Raises:
+        RuntimeError: If the window is not initialized.
+    """
+def set_icon(path: str) -> None:
+    """
+    Set the window icon from an image file.
+    
+    Args:
+        path (str): The file path to the image to use as the icon.
+    
+    Raises:
+        RuntimeError: If the window is not initialized or icon setting fails.
+    """
+def set_title(title: str) -> None:
+    """
+    Set the title of the window.
+    
+    Args:
+        title (str): The new window title. Must be non-empty and <= 255 characters.
+    
+    Raises:
+        RuntimeError: If the window is not initialized or title setting fails.
+        ValueError: If title is empty or exceeds 255 characters.
+    """