parasol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a561d008abe6198982ec891b571cd37d08f6a50ab8b747ff4e4d5bedb370868
+  data.tar.gz: e47e7bbe11d07a15ec1e5c3f9e5640e86743c04dcba687b270a59737a0f58388
+SHA512:
+  metadata.gz: 7efba5cc150b670af0a59feca739e3b0045d2142b71820d4ec3e35baab33ed10c83f5c527f3d8af46b1afa0221c42a97287c9400b3f37c06cb130126834c2c5a
+  data.tar.gz: 83e130d810bacd8c70fc16a389050cd7a5370d907cd509c7d89891a38395c5af5f7553c66fd79789e34ad77d978cff978dfc0434f8ea096cfb637d92de5d2640

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: omit_parentheses
+
+Style/MethodDefParentheses:
+  Enabled: true
+  EnforcedStyle: require_no_parentheses
+
+Style/SignalException:
+  Enabled: true
+  EnforcedStyle: semantic
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SuperWithArgsParentheses:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in parasol.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+
+gem "debug"
+gem "steep", path: "../steep"

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: ../steep
+  specs:
+    steep (1.6.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 3.1.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+
+PATH
+  remote: .
+  specs:
+    parasol (0.1.0)
+      opengl-bindings2 (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abbrev (0.1.2)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    csv (3.2.8)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    ffi (1.16.3)
+    fileutils (1.7.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.1)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
+    minitest (5.21.1)
+    mutex_m (0.2.0)
+    opengl-bindings2 (2.0.2)
+    parallel (1.24.0)
+    parser (3.3.0.3)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.4.1)
+      abbrev
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    securerandom (0.3.1)
+    stringio (3.1.0)
+    strscan (3.0.8)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  debug
+  parasol!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  steep!
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,35 @@
+# Parasol
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/parasol`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://www.github.com/aesthetikx/parasol.
+
+## License
+
+The gem is available as open source under the terms of the [Unlicense](https://opensource.org/licenses/unlicense).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new :spec
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "steep/rake_task"
+Steep::RakeTask.new do |t|
+  t.check.severity_level = :error
+end
+
+task default: %i[spec steep rubocop]

data/Steepfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature "sig"
+
+  check "lib"
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/parasol/fragment_shader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Parasol
+  class FragmentShader < Parasol::Shader
+    def initialize source:
+      super source:, type: GL::FRAGMENT_SHADER
+    end
+  end
+end

data/lib/parasol/geometry_shader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Parasol
+  class GeometryShader < Parasol::Shader
+    def initialize source:
+      super source:, type: GL::GEOMETRY_SHADER
+    end
+  end
+end

data/lib/parasol/opengl_context.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Parasol
+  # :nodoc:
+  module OpenGLContext
+    def require_opengl_context!
+      return unless GLFW.GetCurrentContext.null?
+
+      fail Parasol::ShaderError, "No OpenGL context available."
+    end
+  end
+end

data/lib/parasol/shader.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Parasol
+  class Shader
+    include OpenGLContext
+
+    attr_reader :source, :type
+
+    def initialize source:, type:
+      @source = source
+      @type = type
+    end
+
+    def handle
+      the_shader || compile_the_shader!
+    end
+
+    def delete
+      cleanup
+    end
+
+    def compiled?
+      !the_shader.nil?
+    end
+
+    private
+
+    LOG_SIZE = 8192
+
+    attr_reader :the_shader
+
+    def compile_the_shader!
+      if compiled?
+        return the_shader # : Integer
+      end
+
+      require_opengl_context!
+
+      @the_shader = create_shader!
+
+      compile_shader!
+    end
+
+    def create_shader!
+      GL.CreateShader(type).tap do |pointer|
+        fail Parasol::ShaderError, "Unable to create shader." if pointer.zero?
+      end
+    end
+
+    def compile_shader!
+      GL.ShaderSource the_shader, 1, packed_source, nil
+
+      GL.CompileShader the_shader
+
+      if compiled_successfully?
+        return the_shader # : Integer
+      end
+
+      message = last_error_message
+
+      fail Parasol::ShaderError, "Unable to compile shader:\n#{message}"
+    rescue Parasol::ShaderError
+      cleanup
+
+      raise
+    end
+
+    def compiled_successfully?
+      compile_status == GL::TRUE
+    end
+
+    def packed_source
+      [source].pack "p"
+    end
+
+    def compile_status
+      status_buffer = " " * 4
+
+      GL.GetShaderiv the_shader, GL::COMPILE_STATUS, status_buffer
+
+      status = status_buffer.unpack1 "L"
+
+      status&.to_i
+    end
+
+    def last_error_message
+      length_buffer = " " * 4
+      log_buffer = " " * LOG_SIZE
+
+      GL.GetShaderInfoLog the_shader, LOG_SIZE, length_buffer, log_buffer
+
+      log_buffer.strip
+    end
+
+    def cleanup
+      return unless compiled?
+
+      require_opengl_context!
+
+      GL.DeleteShader the_shader
+    ensure
+      @the_shader = nil
+    end
+  end
+end

data/lib/parasol/shader_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Parasol
+  class ShaderError < Error; end
+end

data/lib/parasol/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Parasol
+  VERSION = "0.1.0"
+end

data/lib/parasol/vertex_shader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Parasol
+  class VertexShader < Parasol::Shader
+    def initialize source:
+      super source:, type: GL::VERTEX_SHADER
+    end
+  end
+end

data/lib/parasol.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "opengl"
+require "glfw"
+
+require_relative "parasol/version"
+
+module Parasol
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+require_relative "parasol/opengl_context"
+require_relative "parasol/shader"
+require_relative "parasol/shader_error"
+require_relative "parasol/fragment_shader"
+require_relative "parasol/geometry_shader"
+require_relative "parasol/vertex_shader"

data/parasol.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/parasol/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "parasol"
+  spec.version = Parasol::VERSION
+  spec.authors = ["John DeSilva"]
+  spec.email = ["john@aesthetikx.info"]
+
+  spec.summary = "A Ruby Shader Library"
+  spec.description = spec.summary
+  spec.homepage = "https://www.github.com/Aesthetikx/parasol"
+  spec.license = "Unlicense"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/aesthetikx/parasol"
+  spec.metadata["changelog_uri"] = "https://www.github.com/aesthetikx/parasol/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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 __dir__ do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename f }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "opengl-bindings2", "~> 2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/parasol/fragment_shader.rbs

@@ -0,0 +1,5 @@
+module Parasol
+  class FragmentShader < Parasol::Shader
+    def initialize: (source: String) -> void
+  end
+end

data/sig/parasol/geometry_shader.rbs

@@ -0,0 +1,5 @@
+module Parasol
+  class GeometryShader < Parasol::Shader
+    def initialize: (source: String) -> void
+  end
+end

data/sig/parasol/opengl_context.rbs

@@ -0,0 +1,6 @@
+module Parasol
+  # :nodoc:
+  module OpenGLContext
+    def require_opengl_context!: () -> nil
+  end
+end

data/sig/parasol/shader.rbs

@@ -0,0 +1,39 @@
+module Parasol
+  class Shader
+    include OpenGLContext
+
+    attr_reader source: String
+
+    attr_reader type: Integer
+
+    def initialize: (source: String, type: Integer) -> void
+
+    def handle: () -> Integer
+
+    def delete: () -> nil
+
+    def compiled?: () -> bool
+
+    private
+
+    LOG_SIZE: Integer
+
+    attr_reader the_shader: Integer?
+
+    def compile_the_shader!: () -> Integer
+
+    def create_shader!: () -> Integer
+
+    def compile_shader!: () -> Integer
+
+    def compiled_successfully?: () -> bool
+
+    def packed_source: () -> String
+
+    def compile_status: () -> Integer?
+
+    def last_error_message: () -> String
+
+    def cleanup: () -> nil
+  end
+end

data/sig/parasol/shader_error.rbs

@@ -0,0 +1,4 @@
+module Parasol
+  class ShaderError < Error
+  end
+end

data/sig/parasol/vertex_shader.rbs

@@ -0,0 +1,5 @@
+module Parasol
+  class VertexShader < Parasol::Shader
+    def initialize: (source: String) -> void
+  end
+end

data/sig/parasol.rbs

@@ -0,0 +1,6 @@
+module Parasol
+  VERSION: String
+
+  class Error < StandardError
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: parasol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeSilva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opengl-bindings2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A Ruby Shader Library
+email:
+- john@aesthetikx.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- Steepfile
+- UNLICENSE
+- lib/parasol.rb
+- lib/parasol/fragment_shader.rb
+- lib/parasol/geometry_shader.rb
+- lib/parasol/opengl_context.rb
+- lib/parasol/shader.rb
+- lib/parasol/shader_error.rb
+- lib/parasol/version.rb
+- lib/parasol/vertex_shader.rb
+- parasol.gemspec
+- sig/parasol.rbs
+- sig/parasol/fragment_shader.rbs
+- sig/parasol/geometry_shader.rbs
+- sig/parasol/opengl_context.rbs
+- sig/parasol/shader.rbs
+- sig/parasol/shader_error.rbs
+- sig/parasol/vertex_shader.rbs
+homepage: https://www.github.com/Aesthetikx/parasol
+licenses:
+- Unlicense
+metadata:
+  homepage_uri: https://www.github.com/Aesthetikx/parasol
+  source_code_uri: https://www.github.com/aesthetikx/parasol
+  changelog_uri: https://www.github.com/aesthetikx/parasol/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby Shader Library
+test_files: []