vulkan-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4e91996880b37a0bcc68cb5de39c77548ac6ea67d58113ddfc65927f27057d2
+  data.tar.gz: 1c7388e401c3ab6333a16692bdef1ea93ed2eb4a679df76e5293689961be5296
+SHA512:
+  metadata.gz: 347af9ac09f59bfa1e6abf7d234a7b4f944948278e437ea6de656da5438ae06b8a70f50bb05013decbae8798a4f5fd20f4d3aa844d27e8b970cebb347387afe6
+  data.tar.gz: ab22ca625acba220effad579ed4a103d43f5bd128ec636b251bd6f98979dc35901a60b777f5fff05415505d2307a2932ef3be5b4538b12d5ea3038b7789725a7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/ports
+.DS_Store

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.add_filter 'vulkan/generated/'
+
+if ENV['COVERAGE']
+  SimpleCov.command_name ENV['COVERAGE']
+  SimpleCov.start
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 3.1.1
+before_install: gem install bundler -v 2.2.0.rc.1

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 vulkan-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    vulkan-ruby (0.1.0)
+      sorted_set
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cglm (0.1.1)
+    chunky_png (1.3.12)
+    docile (1.3.2)
+    mini_portile2 (2.4.0)
+    minitest (5.15.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    oily_png (1.2.1)
+      chunky_png (~> 1.3.7)
+    rake (13.0.1)
+    rbtree (0.4.5)
+    ruby-sdl2 (0.3.5)
+    sdl2_vulkan (0.1.0)
+      ruby-sdl2 (~> 0.3)
+    set (1.0.2)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
+    tiny_obj (0.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  cglm (~> 0.1)
+  chunky_png (~> 1.3)
+  minitest (~> 5.15)
+  nokogiri (~> 1.8)
+  oily_png (~> 1.2)
+  rake (~> 13.0)
+  sdl2_vulkan (~> 0.1)
+  simplecov (~> 0.16)
+  tiny_obj (~> 0.2)
+  vulkan-ruby!
+
+BUNDLED WITH
+   2.2.0.rc.1

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,93 @@
+# `vulkan-ruby`
+
+Exposes [Vulkan](https://www.khronos.org/vulkan/), the next-generation graphics library, to Ruby!
+
+**NOTICE**: Vulkan is neither a small nor simple API to implement. While this library is rapidly reaching a point of usability, it's quite possible you will find that it is insufficient in some way. You are encouraged to open new issues for missing functionality that should otherwise be possible with Vulkan (bonus points for pull requests). The rule of thumb is that if it can be done with Vulkan in C, it should be equally doable using this library.
+
+Higher level abstractions must be evaluated on a case by case basis and are not guaranteed to be added. For example, something explicitly specified in the Vulkan spec such as `vkCmdBindPipeline` or an official extension such as `vk_nv_external_memory` should definitely work in `vulkan-ruby` and support would absolutely be added for them if they don't already work. An implementation of cascading shadow maps, on the other hand, would be better implemented as a standalone ruby gem and at least at the time of this writing would likely be rejected unless a very good explanation could be given for having it.
+
+## Screenshots
+
+![VT10 - Multisampling - Viking Room](https://github.com/sinisterchipmunk/vulkan-ruby/blob/master/examples/screenshots/vt10-viking_room.png)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vulkan-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vulkan-ruby
+
+## Usage
+
+This library is intended to be a rather shallow wrapper around the Vulkan APIs. It does some things that are nifty (like tying garbage collection of Vulkan resources to the Ruby garbage collector), but mostly the design goal is to give you an interface into Vulkan without getting in the way. As with Vulkan itself, some things are possible to do in a number of different ways, depending on your specific use case. Nothing that is possible in Vulkan should prove _impossible_ to do with `vulkan-ruby`.
+
+You are encouraged to [check out the examples](https://github.com/sinisterchipmunk/vulkan-ruby/tree/master/examples/) for some specific usage examples.
+
+### Extensions and Layers
+
+If the environment variable `DEBUG` is set, the following extensions and layers will be added (only if supported by the underlying implementation):
+
+* Instance Extensions
+
+```
+    VK_EXT_debug_utils
+```
+
+* Layers
+
+```
+    VK_LAYER_GOOGLE_threading
+    VK_LAYER_GOOGLE_unique_objects
+    VK_LAYER_LUNARG_api_dump
+    VK_LAYER_LUNARG_assistant_layer
+    VK_LAYER_LUNARG_core_validation
+    VK_LAYER_LUNARG_demo_layer
+    VK_LAYER_LUNARG_monitor
+    VK_LAYER_LUNARG_object_tracker
+    VK_LAYER_LUNARG_parameter_validation
+    VK_LAYER_LUNARG_standard_validation
+    VK_LAYER_LUNARG_starter_layer
+```
+
+In addition to the usual mechanisms for explicit and implicit Vulkan extensions, you can also provide the following environment variables to list extensions/layers to be activated. These get injected into the lists provided by the application to Vulkan, rather than interpreted by Vulkan itself. Multiple entries can be separated by spaces (` `) or by colons (`:`).
+
+      LAYERS
+      INSTANCE_EXTENSIONS
+      DEVICE_EXTENSIONS
+
+
+## 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).
+
+When running `rake`, you can pass `PATH_TO_VULKAN` to specify the Vulkan library to load during testing. Otherwise `NULL` will be passed into SDL2, indicating that it should search for the library.
+
+Everything in `lib/vulkan/generated/` was automatically generated by processing the Vulkan `vk.xml` spec file. To (re)generate these files, first fetch `vk.xml` with `rake fetch`, and then generate the files with `rake generate`, or do it all in one command like so:
+
+```bash
+$ bundle exec rake fetch generate
+```
+
+After (re)generating the files, run `rake` with no arguments, which will invoke both the unit tests and the example files, to (a) check that nothing was broken by the new files, and (b) check that the generated files are correct.
+
+If you discover that the generated files are not correct (for instance, lacking some structs or enums or some generated results just have wrong values), write a unit test to assert the expected result before modifying the generation Rake tasks in `tasks/**/*.rake`. Or at least write the test once you get the result you're looking for. The point is, since these rake tasks are both complicated and mission-critical, unit tests need to be written to be sure that there are no regressions as they evolve over time.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinisterchipmunk/vulkan-ruby.
+
+## 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,14 @@
+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
+
+Dir[File.expand_path('tasks/**/*.{rake,rb}', __dir__)].each do |file|
+  load File.expand_path(file, __dir__)
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vulkan/ruby"
+
+# 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,9 @@
+#!/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
+bundle exec ruby bin/build-fiddle.rb

data/bin/setup.bat

@@ -0,0 +1,2 @@
+call bundle install
+call bundle exec ruby bin\build-fiddle.rb