Crate spottedcat

Expand description

§spottedcat

Spottedcat is a lightweight cross-platform 2D/3D game engine built with Rust and wgpu. It provides a simple API for rendering, input, audio, text, and scene management across desktop, web, iOS, and Android. Designed for fast prototyping and creative interactive projects, it aims to stay small, practical, and easy to use.

§Basic Example

use spottedcat::{Context, Spot, Image, DrawOption, Pt, WindowConfig};
use std::time::Duration;

struct MyApp {
    image: Image,
}

impl Spot for MyApp {
    fn initialize(ctx: &mut Context) -> Self {
        // Create an image from raw RGBA8 data
        let rgba = vec![255u8; 64 * 64 * 4]; // Red square
        let image = Image::new(ctx, Pt::from(64.0), Pt::from(64.0), &rgba)
            .expect("Failed to create image");
        Self { image }
    }

    fn update(&mut self, _ctx: &mut Context, _dt: Duration) {
        // Handle logic here
    }

    fn draw(&mut self, ctx: &mut Context) {
        let (w, h) = spottedcat::window_size(ctx);
         
        // Draw image at center
        let opts = DrawOption::default()
            .with_position([w / 2.0, h / 2.0])
            .with_scale([2.0, 2.0]);
             
        self.image.draw(ctx, opts);
    }

    fn remove(&mut self, _ctx: &mut Context) {}
}

fn main() {
    spottedcat::run::<MyApp>(WindowConfig {
        title: "SpottedCat Example".to_string(),
        ..Default::default()
    });
}

Re-exports§

pub use image::Bounds;
pub use image::Image;
pub use text::Text;

Modules§

image
math: Centralized 3D math utilities using ultraviolet internally. All public APIs use standard Rust arrays to hide implementation details.
text

Structs§

Context: Drawing context for managing render commands.
DrawOption: Unified options for drawing images and text.
InputManager: Manages the state of all input devices (keyboard, mouse, touch, sensors).
OneShotSplash: A reusable startup splash scene with the built-in Spottedcat branding.
Pt: A single dimension unit for logical screen positions and sizes.
ShaderOpts: Uniform options passed to the fragment shader during rendering.
SoundOptions: Configuration options for playing a sound.
TouchInfo: Information about a single active touch point.
WindowConfig: Configuration for the application window.

Enums§

Key: Represents a physical key on a keyboard.
MouseButton: Represents a button on a mouse or similar pointing device.
PlatformEvent: Events received from the native platform (e.g. Android JNI or iOS ObjC).
TouchPhase: Represents the current state of a touch interaction.

Traits§

Spot: The core trait for defining application logic and rendering.

Functions§

compress_assets: Forces pending asset compression work to run immediately.
cursor_position: Alias for mouse_pos.
delta_time: Returns the time elapsed since the last frame.
dt: Returns the time elapsed since the last frame in seconds.
fade_in_sound: Initiates a fade-in for a playing sound.
fade_out_sound: Initiates a fade-out for a playing sound.
get_input: Compatibility alias for text_input.
get_registered_font: Returns a copy of the raw bytes for a registered font.
get_resource: Returns a resource of type T from the context, if it exists.
ime_preedit: Returns the current IME pre-edit string (uncommitted text).
insert_resource: Inserts or replaces a resource of type T in the context.
is_background_transparent: Returns whether the current window background is transparent.
is_sound_playing: Returns true if the sound associated with the play ID is still active.
key_down: Returns true if the specified key is currently held down.
key_pressed: Returns true if the specified key was just pressed this frame.
key_released: Returns true if the specified key was just released this frame.
load_asset: Loads an asset from disk or from the platform-specific bundle.
mouse_button_down: Returns true if the specified mouse button is currently held down.
mouse_button_pressed: Returns true if the specified mouse button was just pressed this frame.
mouse_button_pressed_position: Returns the cursor position if the mouse button was just pressed this frame.
mouse_button_released: Returns true if the specified mouse button was just released this frame.
mouse_down: Returns true if the specified mouse button is currently held down.
mouse_pos: Returns the current mouse position in logical coordinates.
mouse_pressed: Returns true if the specified mouse button was just pressed this frame.
pause_sound: Pauses a currently playing sound by its play ID.
play_sine: A debug function to play a simple sine wave at the specified frequency.
play_sound: Plays a registered sound with the specified options.
play_sound_simple: A convenience function to play a registered sound with default options.
poll_platform_events: Returns a list of raw platform events received this frame.
pt: Creates a logical point value (Pt) from a scalar.
push_platform_event: Pushes a custom platform event into the event queue.
quit: Signals the engine to quit the application.
quit_ctx: Quit helper that keeps the ctx-first API shape.
register_font: Registers a TTF/OTF font for text rendering and returns a unique font ID.
register_image_shader: Registers an image shader and returns its shader id.
register_shader: Registers a custom WGSL fragment shader extension for image rendering.
register_sound: Registers a sound from raw bytes and returns a unique sound ID.
resume_sound: Resumes a paused sound by its play ID.
run: Starts the application with the specified scene type T and configuration.
scale_factor: Returns the window’s scale factor (DPI).
set_background_transparent: Sets whether the current window background should be transparent.
set_cursor_visible: Requests cursor visibility update.
set_fullscreen: Requests fullscreen toggle.
set_sound_volume: Sets the volume of a playing sound directly.
set_text_input_enabled: Enables or disables text input (IME) for the window.
set_window_size: Sets the window’s logical size.
set_window_title: Requests a window title update.
stop_all_sounds: Stops all currently playing sounds.
stop_sound: Stops a playing sound immediately by its play ID.
switch_scene: Switches to a new scene of type T.
switch_scene_ctx: Scene switch helper that keeps the ctx-first API shape.
switch_scene_with: Switches to a new scene of type T and passes a payload.
switch_scene_with_ctx: Scene switch with payload helper that keeps the ctx-first API shape.
take_resource: Removes and returns a resource of type T from the context, if it exists.
text_input: Returns the accumulated text input string for the current frame.
text_input_enabled: Returns true if text input (IME) is currently enabled.
total_elapsed: Returns total elapsed time since engine start.
touch_down: Returns true if any touch point is currently active.
touches: Returns a slice of active touch points.
unregister_font
unregister_sound: Unregisters a sound and frees its resources.
vh: Returns a percentage of the window height as Pt.
vw: Returns a percentage of the window width as Pt.
window_size: Returns the window’s logical size as a tuple of (width, height).

Crate spottedcat

Crate spottedcat Copy item path

§spottedcat

§Basic Example

Re-exports§

Modules§

Structs§

Enums§

Traits§

Functions§

Crate spottedcat