raylib-bindings 0.0.10 → 0.1.0

data/README.md

@@ -1,122 +1,143 @@
-<!-- -*- mode:markdown; coding:utf-8; -*- -->
-
-# Yet another raylib wrapper for Ruby #
-
-*   Created : 2021-10-17
-*   Last modified : 2022-08-12
-
-Provides Ruby bindings for raylib-related libraries including:
-
-*   [raylib](https://github.com/raysan5/raylib)
-    *   raylib
-    *   raymath
-    *   rlgl
-*   [raygui](https://github.com/raysan5/raygui)
-*   [Physac](https://github.com/raysan5/physac)
-
-## Features ##
-
-*   Generated semi-automatically
-*   Based on Ruby/FFI
-    *   No need to build C extension library
-
-## Prerequisites ##
-
-*   Ruby interpreter
-    *   Tested on:
-        *   [macOS]
-            *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [arm64-darwin21]
-        *   [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
-            *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x64-mingw-ucrt]
-
-*   Compiler
-    *   Tested on:
-        *   [macOS] clang
-
-                $ clang --version
-                Apple clang version 13.1.6 (clang-1316.0.21.2.5)
-                Target: arm64-apple-darwin21.5.0
-                Thread model: posix
-                InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
-
-        *   [Windows] gcc
-
-                gcc (Rev10, Built by MSYS2 project) 11.2.0
-
-*   CMake https://cmake.org/download/
-
-<details>
-<summary>Older versions</summary>
-
-*   Ruby interpreter
-    *   Tested on:
-        *   [macOS]
-            *   ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [arm64-darwin20]
-            *   ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [arm64-darwin20]
-        *   [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
-            *   ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x64-mingw-ucrt]
-            *   ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x64-mingw32]
-
-*   Compiler
-    *   Tested on:
-        *   [macOS] clang
-
-                $ clang --version
-                Apple clang version 13.1.6 (clang-1316.0.21.2.3)
-                Target: arm64-apple-darwin21.5.0
-                Thread model: posix
-                InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
-
-                Apple clang version 13.0.0 (clang-1300.0.29.3)
-                Target: arm64-apple-darwin20.6.0
-                Thread model: posix
-                InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
-
-        *   [Windows] gcc
-
-                gcc (Rev9, Built by MSYS2 project) 11.2.0
-
-</details>
-
-## Limitation ##
-
-*   `SetTraceLogCallback` and `TraceLogCallback` are unusable since Ruby-FFI does not support `:varargs` parameter in callbacks (`Proc`, etc.)
-    *   Ref.: https://ffi.github.io/ruby-ffi-archive/messages/20130214-%5Bruby-ffi%5D%20Re_%20Callback%20Function%20with%20varargs-345.html
-
-## License ##
-
-Shared libraries in `lib` directory are built on top of these products and are available under the terms of these licenses:
-
-*   `libraylib.dylib`, `libraylib.dll`
-    *   raylib ( https://github.com/raysan5/raylib )
-        *   https://github.com/raysan5/raylib/blob/master/LICENSE
-*   `raygui.dylib`, `raygui.dll`
-    *   raygui ( https://github.com/raysan5/raygui )
-        *   https://github.com/raysan5/raygui/blob/master/LICENSE
-*   `physac.dylib`, `physac.dll`
-    *   Physac ( https://github.com/raysan5/physac )
-        *   https://github.com/raysan5/physac/blob/4a8e17f263fb8e1150b3fbafc96f880c7d7a4833/src/physac.h#L51-L68
-
-All ruby codes here are available under the terms of the zlib/libpng License ( http://opensource.org/licenses/Zlib ).
-
-    Ruby-raylib : Yet another raylib wrapper for Ruby
-    Copyright (c) 2021-2022 vaiorabbit <http://twitter.com/vaiorabbit>
-
-    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.
+<!-- -*- mode:markdown; coding:utf-8; -*- -->
+
+# Yet another raylib wrapper for Ruby #
+
+*   Created : 2021-10-17
+*   Last modified : 2022-08-28
+
+Provides Ruby bindings for raylib-related libraries including:
+
+*   [raylib](https://github.com/raysan5/raylib)
+    *   raylib
+    *   raymath
+    *   rlgl
+*   [raygui](https://github.com/raysan5/raygui)
+*   [Physac](https://github.com/raysan5/physac)
+
+## Features ##
+
+*   Generated semi-automatically
+*   Based on Ruby/FFI
+    *   No need to build C extension library
+
+## Quick Start ##
+
+For Windows and macOS users:
+
+```
+D:\> gem install raylib-bindings
+Fetching raylib-bindings-...
+...
+1 gem installed
+
+D:\> ruby -r raylib -e 'Raylib.template'
+[Info] Raylib.template : C:/Ruby31-x64/lib/ruby/gems/3.1.0/gems/raylib-bindings-0.0.11/examples/template.rb => d://template.rb
+[Info] Raylib.template : Done
+
+D:\> ruby template.rb
+```
+↓
+
+<img src="https://raw.githubusercontent.com/vaiorabbit/raylib-bindings/main/doc/template_screenshot.png" width="400">
+
+## Prerequisites ##
+
+*   Ruby interpreter
+    *   Tested on:
+        *   [macOS]
+            *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [arm64-darwin21]
+        *   [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
+            *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x64-mingw-ucrt]
+
+*   If you need to build DLLs/shared libralies for your own runtime envrioenment (Linux, etc.):
+    *   CMake https://cmake.org/download/
+    *   C Compiler
+        *   Tested compilers:
+            *   [macOS] clang
+
+                    $ clang --version
+                    Apple clang version 13.1.6 (clang-1316.0.21.2.5)
+                    Target: arm64-apple-darwin21.5.0
+                    Thread model: posix
+                    InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
+
+            *   [Windows] gcc
+
+                    gcc (Rev10, Built by MSYS2 project) 11.2.0
+
+
+<details>
+<summary>Older versions</summary>
+
+*   Ruby interpreter
+    *   Tested on:
+        *   [macOS]
+            *   ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [arm64-darwin20]
+            *   ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [arm64-darwin20]
+        *   [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
+            *   ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x64-mingw-ucrt]
+            *   ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x64-mingw32]
+
+*   Compiler
+    *   Tested on:
+        *   [macOS] clang
+
+                $ clang --version
+                Apple clang version 13.1.6 (clang-1316.0.21.2.3)
+                Target: arm64-apple-darwin21.5.0
+                Thread model: posix
+                InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
+
+                Apple clang version 13.0.0 (clang-1300.0.29.3)
+                Target: arm64-apple-darwin20.6.0
+                Thread model: posix
+                InstalledDir: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin
+
+        *   [Windows] gcc
+
+                gcc (Rev9, Built by MSYS2 project) 11.2.0
+
+</details>
+
+## Limitation ##
+
+*   `SetTraceLogCallback` and `TraceLogCallback` are unusable since Ruby-FFI does not support `:varargs` parameter in callbacks (`Proc`, etc.)
+    *   Ref.: https://ffi.github.io/ruby-ffi-archive/messages/20130214-%5Bruby-ffi%5D%20Re_%20Callback%20Function%20with%20varargs-345.html
+
+## License ##
+
+Shared libraries in `lib` directory are built on top of these products and are available under the terms of these licenses:
+
+*   `libraylib.dylib`, `libraylib.dll`
+    *   raylib ( https://github.com/raysan5/raylib )
+        *   https://github.com/raysan5/raylib/blob/master/LICENSE
+*   `raygui.dylib`, `raygui.dll`
+    *   raygui ( https://github.com/raysan5/raygui )
+        *   https://github.com/raysan5/raygui/blob/master/LICENSE
+*   `physac.dylib`, `physac.dll`
+    *   Physac ( https://github.com/raysan5/physac )
+        *   https://github.com/raysan5/physac/blob/4a8e17f263fb8e1150b3fbafc96f880c7d7a4833/src/physac.h#L51-L68
+
+All ruby codes here are available under the terms of the zlib/libpng License ( http://opensource.org/licenses/Zlib ).
+
+    Ruby-raylib : Yet another raylib wrapper for Ruby
+    Copyright (c) 2021-2022 vaiorabbit <http://twitter.com/vaiorabbit>
+
+    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.

data/examples/template.rb

@@ -0,0 +1,146 @@
+# Yet another raylib wrapper for Ruby
+#
+# * https://github.com/vaiorabbit/raylib-bindings
+#
+# Demonstrates several key features including:
+# * Core      : window management, camera, etc.
+# * Gameplay  : fetching player input, collision handling, etc.
+# * Rendering : drawing shapes, texts, etc.
+#
+# To get more information, see:
+# * https://www.raylib.com/cheatsheet/cheatsheet.html for API reference
+# * https://github.com/vaiorabbit/raylib-bindings/tree/main/examples for more actual codes written in Ruby
+
+require 'raylib'
+
+shared_lib_path = Gem::Specification.find_by_name('raylib-bindings').full_gem_path + '/lib/'
+
+case RUBY_PLATFORM
+when /mswin|msys|mingw|cygwin/
+  Raylib.load_lib(shared_lib_path + 'libraylib.dll', raygui_libpath: shared_lib_path + 'raygui.dll', physac_libpath: shared_lib_path + 'physac.dll')
+when /darwin/
+  Raylib.load_lib(shared_lib_path + 'libraylib.dylib', raygui_libpath: shared_lib_path + 'raygui.dylib', physac_libpath: shared_lib_path + 'physac.dylib')
+else
+  raise RuntimeError, "Unknown OS: #{RUBY_PLATFORM}"
+end
+
+include Raylib
+
+if __FILE__ == $PROGRAM_NAME
+  screen_width = 1280
+  screen_height = 720
+  InitWindow(screen_width, screen_height, "Yet Another Ruby-raylib bindings")
+  SetTargetFPS(60)
+
+  ruby_red = Color.from_u8(155, 17, 30, 255)
+
+  # Camera
+  camera = Camera.new
+  reset_camera = lambda {
+    camera[:position] = Vector3.create(0.0, 10.0, 10.0)
+    camera[:target] = Vector3.create(0.0, 0.0, 0.0)
+    camera[:up] = Vector3.create(0.0, 1.0, 0.0)
+    camera[:fovy] = 45.0
+    camera[:projection] = CAMERA_PERSPECTIVE
+  }
+  reset_camera.call
+  SetCameraMode(camera, CAMERA_FREE)
+  auto_rotate = false
+
+  # Player (red cube) settings
+  player_pos = Vector3.create(0.0, 0.0, 0.0)
+  player_size = Vector3.create(2.0, 2.0, 2.0)
+  speed = 0.25
+
+  # Obstacle settings
+  obstacle_cube_pos = Vector3.create(-4.0, 1.0, 0.0)
+  obstacle_cube_size = Vector3.create(2.0, 2.0, 2.0)
+  obstacle_sphere_pos = Vector3.create(4.0, 0.0, 0.0)
+  obstacle_sphere_size = 1.5
+
+  until WindowShouldClose()
+    ### Update phase
+
+    # Reset camera settings
+    if IsKeyPressed(KEY_F1)
+      auto_rotate = !auto_rotate
+      reset_camera.call
+      SetCameraMode(camera, auto_rotate ? CAMERA_ORBITAL : CAMERA_FREE)
+    end
+    UpdateCamera(camera)
+
+    # Calculate move direction
+    move = Vector3.create(0, 0, 0)
+    move[:x] += speed if IsKeyDown(KEY_RIGHT)
+    move[:x] -= speed if IsKeyDown(KEY_LEFT)
+    move[:z] += speed if IsKeyDown(KEY_DOWN)
+    move[:z] -= speed if IsKeyDown(KEY_UP)
+
+    to_camera = Vector3Normalize(Vector3.create(camera[:position][:x], 0, camera[:position][:z]))
+    rotate_y = QuaternionFromVector3ToVector3(Vector3.create(0, 0, 1), to_camera)
+    move = Vector3RotateByQuaternion(move, rotate_y)
+
+    player_pos = Vector3Add(player_pos, move)
+    player_screen_pos = GetWorldToScreen(Vector3.create(player_pos[:x], player_pos[:y] + 2.5, player_pos[:z]), camera)
+
+    # Check collision status
+    collision = false
+
+    player_bbox = BoundingBox.create(player_pos[:x] - player_size[:x]/2,
+                                     player_pos[:y] - player_size[:y]/2,
+                                     player_pos[:z] - player_size[:z]/2,
+                                     player_pos[:x] + player_size[:x]/2,
+                                     player_pos[:y] + player_size[:y]/2,
+                                     player_pos[:z] + player_size[:z]/2)
+
+    obstacle_cube_bbox = BoundingBox.create(obstacle_cube_pos[:x] - obstacle_cube_size[:x]/2,
+                                            obstacle_cube_pos[:y] - obstacle_cube_size[:y]/2,
+                                            obstacle_cube_pos[:z] - obstacle_cube_size[:z]/2,
+                                            obstacle_cube_pos[:x] + obstacle_cube_size[:x]/2,
+                                            obstacle_cube_pos[:y] + obstacle_cube_size[:y]/2,
+                                            obstacle_cube_pos[:z] + obstacle_cube_size[:z]/2)
+
+    # Check collisions player vs obstacle_cube
+    collision = true if CheckCollisionBoxes(player_bbox, obstacle_cube_bbox)
+
+    # Check collisions player vs obstacle_sphere
+    collision = true if CheckCollisionBoxSphere(player_bbox, obstacle_sphere_pos, obstacle_sphere_size)
+
+    ### Rendering phase
+
+    BeginDrawing()
+
+      ClearBackground(RAYWHITE)
+
+      ## 3D scene
+      BeginMode3D(camera)
+        # Red cube
+        DrawCube(player_pos, 2.0, 2.0, 2.0, collision ? Fade(ruby_red, 0.25) : ruby_red)
+        DrawCubeWires(player_pos, 2.0, 2.0, 2.0, MAROON)
+        # Obstacle cube
+        DrawCube(obstacle_cube_pos, obstacle_cube_size[:x], obstacle_cube_size[:y], obstacle_cube_size[:z], GRAY)
+        DrawCubeWires(obstacle_cube_pos, obstacle_cube_size[:x], obstacle_cube_size[:y], obstacle_cube_size[:z], DARKGRAY)
+        # Obstacle sphere
+        DrawSphere(obstacle_sphere_pos, obstacle_sphere_size, GRAY)
+        DrawSphereWires(obstacle_sphere_pos, obstacle_sphere_size, 16, 16, DARKGRAY)
+        # Floor
+        DrawGrid(10, 1)
+      EndMode3D()
+
+      ## HUD
+      # Text over the red cube
+      DrawText("Player HP: 100 / 100", player_screen_pos[:x] - MeasureText("Player HP: 100/100", 20)/2, player_screen_pos[:y], 20, BLACK)
+      # Help message
+      DrawRectangle(10, screen_height - 100, 300, 80, Fade(MAROON, 0.25))
+      DrawRectangleLines(10, screen_height - 100, 300, 80, ruby_red)
+      DrawText("Arrow keys : move red cube", 20, screen_height - 90, 20, BLACK)
+      DrawText("F1 : camera rotation", 20, screen_height - 70, 20, BLACK)
+      DrawText("ESC : exit", 20, screen_height - 50, 20, BLACK)
+      # FPS
+      DrawFPS(screen_width - 100, 16)
+
+    EndDrawing()
+  end
+
+  CloseWindow()
+end