ruby2d 0.12.0 → 1.0.0

data/assets/build_support/CMakeLists.txt

@@ -0,0 +1,94 @@
+cmake_minimum_required(VERSION 3.16)
+
+# Default to an optimized (Release, -O3) build. SDL, SDL_image, SDL_mixer and
+# SDL_ttf are pulled in via add_subdirectory below, so SDL's own "default to
+# RelWithDebInfo" logic does not apply (it only triggers when SDL is the
+# top-level project). Without this they would compile at -O0 — a large penalty
+# for the WASM build, where every render call goes through that code.
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+  set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
+endif()
+
+project(ruby2d_deps)
+
+# Disable shared libraries (static builds only)
+set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "")
+
+# PIC needed when static libs are later linked into
+# ruby2d.so (shared object), especially on ELF platforms.
+if(UNIX AND NOT APPLE)
+  set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif()
+
+# SDL sources live in ../sources relative to this CMakeLists.txt, unless the
+# caller passes -DRUBY2D_SOURCES_DIR — `ruby2d setup` builds into a per-user
+# cache outside the gem and points cmake at that cache's sources.
+if(NOT RUBY2D_SOURCES_DIR)
+  set(RUBY2D_SOURCES_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../sources")
+endif()
+
+# SDL
+add_subdirectory("${RUBY2D_SOURCES_DIR}/SDL" SDL EXCLUDE_FROM_ALL)
+
+# SDL_image
+set(SDLIMAGE_VENDORED ON)
+set(SDLIMAGE_AVIF OFF)
+set(SDLIMAGE_BMP ON)
+set(SDLIMAGE_GIF ON)
+set(SDLIMAGE_JPG ON)
+set(SDLIMAGE_LBM OFF)
+set(SDLIMAGE_PCX OFF)
+set(SDLIMAGE_PNG ON)
+set(SDLIMAGE_PNM OFF)
+set(SDLIMAGE_QOI OFF)
+set(SDLIMAGE_SVG ON)
+set(SDLIMAGE_TGA OFF)
+set(SDLIMAGE_TIF OFF)
+set(SDLIMAGE_WEBP OFF)
+set(SDLIMAGE_XCF OFF)
+set(SDLIMAGE_XPM OFF)
+set(SDLIMAGE_XV OFF)
+add_subdirectory("${RUBY2D_SOURCES_DIR}/SDL_image" SDL_image EXCLUDE_FROM_ALL)
+
+# SDL_mixer
+set(SDLMIXER_VENDORED ON)
+set(SDLMIXER_FLAC ON)
+set(SDLMIXER_GME OFF)
+set(SDLMIXER_MOD OFF)
+set(SDLMIXER_MP3 ON)
+# Prefer dr_mp3 over libmpg123 on platforms where mpg123 doesn't build cleanly:
+#   - MinGW/Windows ARM64: libmpg123 POSIX cpu-probe code
+#   - Emscripten: mpg123 requires ASM
+#   - Linux ARM64: mpg123 doesn't currently build
+if(MINGW OR EMSCRIPTEN OR
+   (CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64"))
+  set(SDLMIXER_MP3_DRMP3 ON  CACHE BOOL "" FORCE)
+  set(SDLMIXER_MP3_MPG123 OFF CACHE BOOL "" FORCE)
+endif()
+set(SDLMIXER_MIDI OFF)
+set(SDLMIXER_MIDI_NATIVE OFF)
+set(SDLMIXER_OPUS OFF)
+set(SDLMIXER_WAVE ON)
+set(SDLMIXER_WAVPACK OFF)
+add_subdirectory("${RUBY2D_SOURCES_DIR}/SDL_mixer" SDL_mixer EXCLUDE_FROM_ALL)
+
+# SDL_ttf
+set(SDLTTF_VENDORED ON)
+add_subdirectory("${RUBY2D_SOURCES_DIR}/SDL_ttf" SDL_ttf EXCLUDE_FROM_ALL)
+
+# Vendored harfbuzz promotes the -Wunused group to errors via pragmas in
+# hb.hh. Clang 21+ (shipped with recent Emscripten) added -Wunused-template
+# to that group, which fires on harfbuzz 8.x headers and breaks the build.
+# Upstream harfbuzz 11.x fixed this; until SDL_ttf vendors a newer harfbuzz,
+# disable the pragma-based error promotion (compiler defaults still apply).
+if(TARGET harfbuzz)
+  target_compile_definitions(harfbuzz PRIVATE HB_NO_PRAGMA_GCC_DIAGNOSTIC_ERROR)
+endif()
+
+# Build all static libraries as part of the default target
+add_custom_target(deps ALL DEPENDS
+  SDL3::SDL3
+  SDL3_image::SDL3_image
+  SDL3_mixer::SDL3_mixer
+  SDL3_ttf::SDL3_ttf
+)

data/assets/build_support/mruby/build_config.rb

@@ -0,0 +1,34 @@
+# Locate target.rb via RUBY2D_TARGET_RB when this config has been staged outside
+# its source tree (see assets/Rakefile mruby:build, which stages it into the
+# build dir so mruby's scratch/lock files stay out of a read-only gem). Falls
+# back to the in-tree relative path for a normal, in-place build.
+require(ENV['RUBY2D_TARGET_RB'] || File.expand_path('../../target', __dir__))
+
+MRuby::Build.new do |conf|
+  conf.build_dir = File.join(AssetsTarget.build_dir, 'mruby')
+  # Use clang on macOS and Windows ARM64 (mingw-w64-clang-aarch64); gcc elsewhere
+  if RUBY_PLATFORM =~ /darwin/ ||
+     (AssetsTarget.host_os == 'windows' && AssetsTarget.host_arch == 'arm64')
+    conf.toolchain :clang
+  else
+    conf.toolchain :gcc
+  end
+  # Same runtime gems as the "default" gembox, but only the mrbc command —
+  # ruby2d ships libmruby.a + mrbc and nothing else. Skipping the other bin
+  # gems avoids building mruby-bin-mirb, whose bundled strndup fallback
+  # (#ifdef _WIN32) clashes with the strndup already declared by the MSYS2
+  # UCRT/clangarm64 C library, and speeds up the build.
+  conf.gembox 'stdlib'
+  conf.gembox 'stdlib-ext'
+  conf.gembox 'stdlib-io'
+  conf.gembox 'math'
+  conf.gembox 'metaprog'
+  # Plus core gems outside those gemboxes, for CRuby parity: Time#strftime,
+  # String#encoding/#force_encoding, and Kernel#exit. mruby-sleep stays out
+  # on purpose — it would block the frame loop (and on web, the whole tab).
+  # Keep this list in sync with build_config_wasm.rb.
+  conf.gem core: 'mruby-strftime'
+  conf.gem core: 'mruby-encoding'
+  conf.gem core: 'mruby-exit'
+  conf.gem core: 'mruby-bin-mrbc'
+end

data/assets/build_support/mruby/build_config_wasm.rb

@@ -0,0 +1,30 @@
+require(ENV['RUBY2D_TARGET_RB'] || File.expand_path('../../target', __dir__))
+
+MRuby::CrossBuild.new('emscripten') do |conf|
+  conf.build_dir = File.join(AssetsTarget.wasm_build_dir, 'mruby')
+  conf.mrbcfile  = File.join(AssetsTarget.build_dir, 'mruby', 'bin', 'mrbc')
+  toolchain :clang
+  # The same library gems as the native build, minus every bin tool — commands
+  # cross-compiled to wasm are dead weight, and mrbcfile above already points
+  # at the native mrbc. Keep this list in sync with build_config.rb.
+  conf.gembox 'stdlib'
+  conf.gembox 'stdlib-ext'
+  conf.gembox 'stdlib-io'
+  conf.gembox 'math'
+  conf.gembox 'metaprog'
+  conf.gem core: 'mruby-strftime'
+  conf.gem core: 'mruby-encoding'
+  conf.gem core: 'mruby-exit'
+  conf.cc.command = 'emcc'
+  conf.cc.flags << '-O3'
+  # No boxing: mrb_value is a plain struct with the Float stored inline — no
+  # heap allocation per Float. wasm is 32-bit, where the default word boxing
+  # heap-allocates every Float, making float-heavy loops (game math) several
+  # times slower. mruby's own docs point to MRB_NO_BOXING as the 32-bit
+  # escape hatch (NaN boxing trips the 5-word GC cell assert on 32-bit).
+  # Anything compiled against these headers (the ruby2d web/try builds) must
+  # define this too — the boxing mode is ABI.
+  conf.cc.defines << 'MRB_NO_BOXING'
+  conf.linker.command = 'emcc'
+  conf.archiver.command = 'emar'
+end

data/assets/build_support/sdl_test.c

@@ -0,0 +1,174 @@
+/**
+ * SDL3 Test Application
+ *
+ * Tests SDL3 core functionality along with SDL3_image, SDL3_mixer, and SDL3_ttf.
+ * Uses the SDL3 callback-based application model.
+ */
+
+#define SDL_MAIN_USE_CALLBACKS 1
+
+#include <SDL3/SDL.h>
+#include <SDL3/SDL_main.h>
+#include <SDL3_image/SDL_image.h>
+#include <SDL3_mixer/SDL_mixer.h>
+#include <SDL3_ttf/SDL_ttf.h>
+
+/* ============================================================================
+ * Constants
+ * ============================================================================ */
+
+static const int WINDOW_WIDTH = 640;
+static const int WINDOW_HEIGHT = 480;
+static const char *WINDOW_TITLE = "hello world";
+
+static const char *FONT_PATH = "./resources/fonts/outfit/outfit.ttf";
+static const char *IMG_PATH = "./test_media/images/image.png";
+static const char *MUSIC_PATH = "./test_media/audio/music.wav";
+
+/* ============================================================================
+ * Global State
+ * ============================================================================ */
+
+static SDL_Window *window = NULL;
+static SDL_Renderer *renderer = NULL;
+static SDL_Texture *image_texture = NULL;
+static SDL_Texture *message_texture = NULL;
+
+/* ============================================================================
+ * Helper Functions
+ * ============================================================================ */
+
+static SDL_AppResult SDL_Fail(void) {
+  SDL_LogError(SDL_LOG_CATEGORY_CUSTOM, "Error: %s", SDL_GetError());
+  return SDL_APP_FAILURE;
+}
+
+/* ============================================================================
+ * SDL Application Callbacks
+ * ============================================================================ */
+
+/**
+ * Called once at application startup.
+ * Initializes SDL subsystems, creates window/renderer, and loads resources.
+ */
+SDL_AppResult SDL_AppInit(void **appstate, int argc, char *argv[]) {
+  /* Initialize SDL core */
+  if (!SDL_Init(SDL_INIT_VIDEO | SDL_INIT_AUDIO)) {
+    return SDL_Fail();
+  }
+
+  if (!SDL_CreateWindowAndRenderer(WINDOW_TITLE, WINDOW_WIDTH, WINDOW_HEIGHT,
+                                   0, &window, &renderer)) {
+    return SDL_Fail();
+  }
+
+  /* Initialize and load font */
+  if (!TTF_Init()) {
+    return SDL_Fail();
+  }
+
+  TTF_Font *font = TTF_OpenFont(FONT_PATH, 36);
+  if (!font) {
+    return SDL_Fail();
+  }
+
+  /* Render text to texture */
+  const char *text_message = "Hello SDL!";
+  SDL_Color text_color = {255, 255, 255, 255};
+  SDL_Surface *text_surface = TTF_RenderText_Solid(font, text_message,
+                                                   strlen(text_message), text_color);
+  if (!text_surface) {
+    return SDL_Fail();
+  }
+  message_texture = SDL_CreateTextureFromSurface(renderer, text_surface);
+  SDL_DestroySurface(text_surface);
+  TTF_CloseFont(font);
+
+  /* Load PNG image */
+  SDL_Surface *image_surface = IMG_Load(IMG_PATH);
+  if (!image_surface) {
+    return SDL_Fail();
+  }
+  image_texture = SDL_CreateTextureFromSurface(renderer, image_surface);
+  SDL_DestroySurface(image_surface);
+
+  /* Initialize audio mixer and play music */
+  if (!MIX_Init()) {
+    return SDL_Fail();
+  }
+
+  MIX_Mixer *mixer = MIX_CreateMixerDevice(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, NULL);
+  if (!mixer) {
+    return SDL_Fail();
+  }
+
+  MIX_Audio *music = MIX_LoadAudio(mixer, MUSIC_PATH, false);
+  if (!music) {
+    return SDL_Fail();
+  }
+
+  MIX_Track *track = MIX_CreateTrack(mixer);
+  if (!track) {
+    return SDL_Fail();
+  }
+
+  if (!MIX_SetTrackAudio(track, music)) {
+    return SDL_Fail();
+  }
+
+  if (!MIX_PlayTrack(track, 0)) {
+    return SDL_Fail();
+  }
+
+  return SDL_APP_CONTINUE;
+}
+
+/**
+ * Called for each SDL event.
+ * Handles quit events and escape key to exit.
+ */
+SDL_AppResult SDL_AppEvent(void *appstate, SDL_Event *event) {
+  if (event->type == SDL_EVENT_QUIT) {
+    return SDL_APP_SUCCESS;
+  }
+
+  if (event->type == SDL_EVENT_KEY_DOWN &&
+      event->key.scancode == SDL_SCANCODE_ESCAPE) {
+    return SDL_APP_SUCCESS;
+  }
+
+  return SDL_APP_CONTINUE;
+}
+
+/**
+ * Called once per frame.
+ * Renders animated background color with image and text overlays.
+ */
+SDL_AppResult SDL_AppIterate(void *appstate) {
+  const double now = (double)SDL_GetTicks() / 1000.0;
+
+  /* Animate background color using phase-shifted sine waves */
+  const float red   = (float)(0.5 + 0.5 * SDL_sin(now));
+  const float green = (float)(0.5 + 0.5 * SDL_sin(now + SDL_PI_D * 2.0 / 3.0));
+  const float blue  = (float)(0.5 + 0.5 * SDL_sin(now + SDL_PI_D * 4.0 / 3.0));
+
+  SDL_SetRenderDrawColorFloat(renderer, red, green, blue, SDL_ALPHA_OPAQUE_FLOAT);
+  SDL_RenderClear(renderer);
+
+  /* Draw textures */
+  SDL_RenderTexture(renderer, image_texture, NULL, NULL);
+  SDL_RenderTexture(renderer, message_texture, NULL, NULL);
+
+  SDL_RenderPresent(renderer);
+
+  return SDL_APP_CONTINUE;
+}
+
+/**
+ * Called once at application shutdown.
+ * SDL automatically cleans up window and renderer.
+ */
+void SDL_AppQuit(void *appstate, SDL_AppResult result) {
+  SDL_DestroyTexture(image_texture);
+  SDL_DestroyTexture(message_texture);
+}

data/assets/deps.yaml

@@ -0,0 +1,16 @@
+---
+SDL:
+  url: https://github.com/libsdl-org/SDL.git
+  tag: release-3.4.14
+SDL_image:
+  url: https://github.com/libsdl-org/SDL_image.git
+  tag: release-3.4.4
+SDL_mixer:
+  url: https://github.com/libsdl-org/SDL_mixer.git
+  tag: release-3.2.4
+SDL_ttf:
+  url: https://github.com/libsdl-org/SDL_ttf.git
+  tag: release-3.2.2
+mruby:
+  url: https://github.com/mruby/mruby.git
+  tag: 4.0.0

data/assets/platform/include/SDL3/SDL.h

@@ -0,0 +1,91 @@
+/*
+  Simple DirectMedia Layer
+  Copyright (C) 1997-2026 Sam Lantinga <slouken@libsdl.org>
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+*/
+
+/**
+ * Main include header for the SDL library, version 3.4.14
+ *
+ * It is almost always best to include just this one header instead of
+ * picking out individual headers included here. There are exceptions to
+ * this rule--SDL_main.h is special and not included here--but usually
+ * letting SDL.h include the kitchen sink for you is the correct approach.
+ */
+
+#ifndef SDL_h_
+#define SDL_h_
+
+#include <SDL3/SDL_stdinc.h>
+#include <SDL3/SDL_assert.h>
+#include <SDL3/SDL_asyncio.h>
+#include <SDL3/SDL_atomic.h>
+#include <SDL3/SDL_audio.h>
+#include <SDL3/SDL_bits.h>
+#include <SDL3/SDL_blendmode.h>
+#include <SDL3/SDL_camera.h>
+#include <SDL3/SDL_clipboard.h>
+#include <SDL3/SDL_cpuinfo.h>
+#include <SDL3/SDL_dialog.h>
+#include <SDL3/SDL_dlopennote.h>
+#include <SDL3/SDL_endian.h>
+#include <SDL3/SDL_error.h>
+#include <SDL3/SDL_events.h>
+#include <SDL3/SDL_filesystem.h>
+#include <SDL3/SDL_gamepad.h>
+#include <SDL3/SDL_gpu.h>
+#include <SDL3/SDL_guid.h>
+#include <SDL3/SDL_haptic.h>
+#include <SDL3/SDL_hidapi.h>
+#include <SDL3/SDL_hints.h>
+#include <SDL3/SDL_init.h>
+#include <SDL3/SDL_iostream.h>
+#include <SDL3/SDL_joystick.h>
+#include <SDL3/SDL_keyboard.h>
+#include <SDL3/SDL_keycode.h>
+#include <SDL3/SDL_loadso.h>
+#include <SDL3/SDL_locale.h>
+#include <SDL3/SDL_log.h>
+#include <SDL3/SDL_messagebox.h>
+#include <SDL3/SDL_metal.h>
+#include <SDL3/SDL_misc.h>
+#include <SDL3/SDL_mouse.h>
+#include <SDL3/SDL_mutex.h>
+#include <SDL3/SDL_pen.h>
+#include <SDL3/SDL_pixels.h>
+#include <SDL3/SDL_platform.h>
+#include <SDL3/SDL_power.h>
+#include <SDL3/SDL_process.h>
+#include <SDL3/SDL_properties.h>
+#include <SDL3/SDL_rect.h>
+#include <SDL3/SDL_render.h>
+#include <SDL3/SDL_scancode.h>
+#include <SDL3/SDL_sensor.h>
+#include <SDL3/SDL_storage.h>
+#include <SDL3/SDL_surface.h>
+#include <SDL3/SDL_system.h>
+#include <SDL3/SDL_thread.h>
+#include <SDL3/SDL_time.h>
+#include <SDL3/SDL_timer.h>
+#include <SDL3/SDL_tray.h>
+#include <SDL3/SDL_touch.h>
+#include <SDL3/SDL_version.h>
+#include <SDL3/SDL_video.h>
+#include <SDL3/SDL_oldnames.h>
+
+#endif /* SDL_h_ */