sdl2_vulkan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12364f364aa12cf244696414abe0c1de4a48d4b249dcea75cfe2639d469ca9f5
+  data.tar.gz: 31be4a9e97e422033390ee8f254dcf63e39d69da5ae91ee77eecf32dc7d52e82
+SHA512:
+  metadata.gz: 4719162f233e81629c0c0f0d4114d13758c7136f914cc782b64e0b8222dc4035fc264bfbd396142ace0dc5e48f7d7359228df8424d5902b19328f2b122c491dd
+  data.tar.gz: 77f3ea8a98994aa402dbecf4a0592a81617bc7cdfaa394b8e576adfcf671f71c27da75aa81f8d4a70737b1dab83c44b6287a2491267c4998e0a353403801a9ef

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sdl2_vulkan.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    sdl2_vulkan (0.1.0)
+      ruby-sdl2 (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+    ruby-sdl2 (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rake-compiler
+  sdl2_vulkan!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Colin MacKenzie IV
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# `sdl2_vulkan`
+
+Adds on to the [`ruby-sdl2`](https://github.com/ohai/ruby-sdl2) gem to expose
+SDL2's Vulkan functions to Ruby in order to make it possible to present Vulkan
+swapchain images to SDL2 windows.
+
+Requires SDL v2.0.8 or higher, which is when Vulkan support was added to SDL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sdl2_vulkan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sdl2_vulkan
+
+## Usage
+
+See [sdl2_vulkan_test.rb#L11-L24](https://github.com/sinisterchipmunk/sdl2_vulkan/tree/master/test/sdl2_vulkan_test.rb#L11-L24) for usage.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinisterchipmunk/sdl2_vulkan.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("sdl2_vulkan") do |ext|
+  ext.lib_dir = "lib/sdl2_vulkan"
+end
+
+task :default => [:clobber, :compile, :test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sdl2_vulkan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/sdl2_vulkan/extconf.rb

@@ -0,0 +1,49 @@
+require 'mkmf'
+
+# helpers "borrowed" from ruby-sdl2
+def add_cflags(str)
+  $CFLAGS += " " + str
+end
+
+def add_libs(str)
+  $LOCAL_LIBS += " " + str
+end
+
+def run_config_program(*args)
+  IO.popen([*args], "r") do |io|
+    io.gets.chomp
+  end
+end
+
+def sdl2config_with_command
+  sdl2_config = with_config('sdl2-config', 'sdl2-config')
+  add_cflags(run_config_program(sdl2_config, "--cflags"))
+  add_libs(run_config_program(sdl2_config, "--libs"))
+end
+
+def sdl2config_on_mingw
+  have_library("mingw32")
+  have_library("SDL2")
+  add_libs("-mwindows")
+end
+
+case RbConfig::CONFIG["arch"]
+when /mingw/
+  sdl2config_on_mingw
+else
+  sdl2config_with_command
+end
+
+require 'fiddle'
+%w(
+  SIZEOF_VOIDP SIZEOF_CHAR SIZEOF_SHORT SIZEOF_INT SIZEOF_LONG SIZEOF_LONG_LONG
+  SIZEOF_FLOAT SIZEOF_DOUBLE SIZEOF_SIZE_T SIZEOF_SSIZE_T SIZEOF_PTRDIFF_T
+  SIZEOF_INTPTR_T SIZEOF_UINTPTR_T
+).each do |const_name|
+  if Fiddle.constants.include?(const_name.to_sym)
+    $CFLAGS << " -DHAVE_#{const_name}=1 -D#{const_name}=#{Fiddle.const_get(const_name.to_sym)}"
+  end
+end
+
+have_header("SDL_vulkan.h")
+create_makefile("sdl2_vulkan/sdl2_vulkan")

data/ext/sdl2_vulkan/sdl2_vulkan.c

@@ -0,0 +1,133 @@
+#include "sdl2_vulkan.h"
+
+// from ruby-sdl2
+typedef struct Window {
+  SDL_Window* window;
+  int num_renderers;
+  int max_renderers;
+  struct Renderer** renderers;
+} Window;
+
+VALUE rb_mSDL2 = Qnil,
+      rb_cWindow = Qnil,
+      rb_mFlags = Qnil,
+      rb_mVulkan = Qnil;
+
+/*
+ * Loads the Vulkan library. If `path` is given, it will be used; otherwise
+ * the library will be searched for dynamically. Raises an error if the
+ * library could not be loaded.
+ */
+static VALUE Vulkan_load_library(int argc, VALUE *argv, VALUE self) {
+  const char *path = NULL;
+  if (argc > 0 && !NIL_P(argv[0])) path = StringValuePtr(argv[0]);
+  int result = SDL_Vulkan_LoadLibrary(path);
+  if (result != 0) rb_raise(rb_eRuntimeError, "Failed to load Vulkan library: %s", SDL_GetError());
+  return self;
+}
+
+/*
+ * Unloads the Vulkan library.
+ */
+static VALUE Vulkan_unload_library(VALUE self) {
+  SDL_Vulkan_UnloadLibrary();
+  return self;
+}
+
+/*
+ * Returns an integer value which is the memory address of the
+ * vkGetInstanceProcAddr function. The integer value will need to be converted
+ * into something more useful, for instance using
+ * [Fiddle](https://github.com/ruby/fiddle). Returns `nil` if the address
+ * would be NULL.
+ */
+static VALUE Vulkan_get_vk_get_instance_proc_addr(VALUE self) {
+  return PTR2NUM(SDL_Vulkan_GetVkGetInstanceProcAddr());
+}
+
+/*
+ * Returns an array of Vulkan extension names. Raises an error if they could
+ * not be retrieved.
+ */
+static VALUE Window_get_instance_extension_names(VALUE self) {
+  Window *window_data = NULL;
+  Data_Get_Struct(self, Window, window_data);
+  if (window_data == NULL || window_data->window == NULL)
+    rb_raise(rb_eArgError, "Not a window");
+
+  unsigned int count = 0;
+  if (!SDL_Vulkan_GetInstanceExtensions(window_data->window, &count, NULL))
+    rb_raise(rb_eRuntimeError, "Could not query number of extensions");
+  
+  const char **extension_names = malloc(count * sizeof(const char *));
+  if (!SDL_Vulkan_GetInstanceExtensions(window_data->window, &count, extension_names)) {
+    free(extension_names);
+    rb_raise(rb_eRuntimeError, "Could not query extension names");
+  }
+
+  VALUE ary = rb_ary_new();
+  for (unsigned int i = 0; i < count; i++) {
+    rb_ary_push(ary, rb_str_new2(extension_names[i]));
+  }
+  free(extension_names);
+  return ary;
+}
+
+/*
+ * Creates a Vulkan drawing surface for this window. The `instance` argument
+ * should be a number which represents the memory address of the `VkInstance`
+ * (which is a pointer type).
+ *
+ * Raises a runtime error if the operation fails.
+ *
+ * Returns a number representing the memory address of the created surface.
+ *
+ */
+static VALUE Window_create_surface(VALUE self, VALUE instance_addr) {
+  Window *window_data = NULL;
+  Data_Get_Struct(self, Window, window_data);
+  if (window_data == NULL || window_data->window == NULL)
+    rb_raise(rb_eArgError, "Not a window");
+
+  VkInstance instance = (VkInstance) NUM2PTR(instance_addr);
+  VkSurfaceKHR surface;
+  if (!SDL_Vulkan_CreateSurface(window_data->window, instance, &surface))
+    rb_raise(rb_eRuntimeError, "Failed to create drawing surface");
+
+  return PTR2NUM(surface);
+}
+
+/*
+ * Returns an array containing `[width, height]` which are the drawable
+ * dimensions of window in pixels.
+ */
+static VALUE Window_get_drawable_size(VALUE self) {
+  Window *window_data = NULL;
+  Data_Get_Struct(self, Window, window_data);
+  if (window_data == NULL || window_data->window == NULL)
+    rb_raise(rb_eArgError, "Not a window");
+
+  int width  = 0;
+  int height = 0;
+  SDL_Vulkan_GetDrawableSize(window_data->window, &width, &height);
+
+  VALUE ary = rb_ary_new();
+  rb_ary_push(ary, INT2NUM(width));
+  rb_ary_push(ary, INT2NUM(height));
+  return ary;
+}
+
+void Init_sdl2_vulkan(void) {
+  rb_mSDL2   = rb_define_module("SDL2");
+  rb_cWindow = rb_const_get(rb_mSDL2, rb_intern("Window"));
+  rb_mFlags  = rb_const_get(rb_cWindow, rb_intern("Flags"));
+  rb_mVulkan = rb_define_module_under(rb_mSDL2, "Vulkan");
+
+  rb_define_const(rb_mFlags, "VULKAN", INT2NUM(SDL_WINDOW_VULKAN));
+  rb_define_singleton_method(rb_mVulkan, "load_library",              Vulkan_load_library,                 -1);
+  rb_define_singleton_method(rb_mVulkan, "vk_get_instance_proc_addr", Vulkan_get_vk_get_instance_proc_addr, 0);
+  rb_define_singleton_method(rb_mVulkan, "unload_library",            Vulkan_unload_library,                0);
+  rb_define_method(rb_cWindow, "vk_instance_extensions", Window_get_instance_extension_names, 0);
+  rb_define_method(rb_cWindow, "vk_create_surface",      Window_create_surface,               1);
+  rb_define_method(rb_cWindow, "vk_drawable_size",       Window_get_drawable_size,            0);
+}

data/ext/sdl2_vulkan/sdl2_vulkan.h

@@ -0,0 +1,15 @@
+#ifndef SDL2_VULKAN_H
+#define SDL2_VULKAN_H 1
+
+#include "ruby.h"
+#include "SDL2/SDL_vulkan.h"
+
+#if SIZEOF_VOIDP == SIZEOF_LONG
+# define PTR2NUM(x)   (LONG2NUM((long)(x)))
+# define NUM2PTR(x)   ((void*)(NUM2ULONG(x)))
+#else
+# define PTR2NUM(x)   (LL2NUM((LONG_LONG)(x)))
+# define NUM2PTR(x)   ((void*)(NUM2ULL(x)))
+#endif
+
+#endif /* SDL2_VULKAN_H */

data/lib/sdl2_vulkan.rb

@@ -0,0 +1,3 @@
+require 'sdl2'
+require "sdl2_vulkan/version"
+require "sdl2_vulkan/sdl2_vulkan"

data/lib/sdl2_vulkan/version.rb

@@ -0,0 +1,3 @@
+module Sdl2Vulkan
+  VERSION = "0.1.0"
+end

data/sdl2_vulkan.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sdl2_vulkan/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sdl2_vulkan"
+  spec.version       = Sdl2Vulkan::VERSION
+  spec.authors       = ["Colin MacKenzie IV"]
+  spec.email         = ["sinisterchipmunk@gmail.com"]
+
+  spec.summary       = %q{Adds on to ruby-sdl2 to expose Vulkan functions}
+  spec.homepage      = "https://github.com/sinisterchipmunk/ruby-sdl2_vulkan"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/sinisterchipmunk/ruby-sdl2_vulkan"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/sdl2_vulkan/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_dependency 'ruby-sdl2', '~> 0.3'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sdl2_vulkan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin MacKenzie IV
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-sdl2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- sinisterchipmunk@gmail.com
+executables: []
+extensions:
+- ext/sdl2_vulkan/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/sdl2_vulkan/extconf.rb
+- ext/sdl2_vulkan/sdl2_vulkan.c
+- ext/sdl2_vulkan/sdl2_vulkan.h
+- lib/sdl2_vulkan.rb
+- lib/sdl2_vulkan/version.rb
+- sdl2_vulkan.gemspec
+homepage: https://github.com/sinisterchipmunk/ruby-sdl2_vulkan
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sinisterchipmunk/ruby-sdl2_vulkan
+  source_code_uri: https://github.com/sinisterchipmunk/ruby-sdl2_vulkan
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Adds on to ruby-sdl2 to expose Vulkan functions
+test_files: []