gosu 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d1640e560328b803317616abde6c301648daffb
-  data.tar.gz: 419425be00ae9f09d1cc74702170f55f87ff563b
+  metadata.gz: 0e780ad64700f539c7956253b0900d69ab828562
+  data.tar.gz: bf9eea3a88a216860bac22d6cb2b16dddbe363b1
 SHA512:
-  metadata.gz: 6ba0ce007bc4fdddd98887d1594f2b106e150fb50282dc859e517f1122a4853c6d8f3ca69cb8d34cde51914e2310c53eba1ba9873dde736fbac58e6dc0bcef32
-  data.tar.gz: 2eb57895d03d4bfcbcc31c28ef79ef35fa5f78684dde4d1f7106b0914470bf2d70b27aa87b3df23e4432f367aa1bdbbd4883bb39e2915405b9b6aba79ed83775
+  metadata.gz: cae8120cd63eac622abf7a59a5c8e2735dc8d35f5c20a91f4189800d577736ff5eca92e22f1b295165f833f1dc546ada16fb3979a5c5624853242841baee4d8b
+  data.tar.gz: fee3c74049220d40390106f33f444d739b4d614bcdc253225aa6fc2445b936c0de5650c51e9bc34e3ff2c242e0e6d5a5ba782d8558eafbccfcb9f6a7b40e9b35

data/Gosu/Graphics.hpp

@@ -39,7 +39,7 @@ namespace Gosu
 
         //! Prepares the graphics object for drawing and then runs the rendering code in f.
         //! Nothing must be drawn outside of frame() and record().
-        void frame(const std::function<void()>& f);
+        void frame(const std::function<void ()>& f);
         
         //! Flushes the Z queue to the screen and starts a new one.
         //! This can be useful to separate the Z queues of two parts of the game, e.g. the two
@@ -48,27 +48,27 @@ namespace Gosu
         
         //! Finishes all pending Gosu drawing operations and executes the code in f in a clean
         //! OpenGL environment.
-        static void gl(const std::function<void()>& f);
+        static void gl(const std::function<void ()>& f);
 
         //! Schedules a custom GL functor to be executed at a certain Z level.
         //! The functor f is run in a clean GL context.
         //! Note: You may not call any Gosu rendering functions from within the
         //! functor.
-        static void gl(ZPos z, const std::function<void()>& f);
+        static void gl(ZPos z, const std::function<void ()>& f);
         
         //! Renders everything drawn in f clipped to a rectangle on the screen.
         static void clip_to(double x, double y, double width, double height,
-                            const std::function<void()>& f);
+                            const std::function<void ()>& f);
         
         //! Records a macro and returns it as an ImageData instance.
         //! Usually, the return value is passed to Image::Image().
         //! Cannot be nested.
         static std::unique_ptr<Gosu::ImageData> record(int width, int height,
-                                                       const std::function<void()>& f);
+                                                       const std::function<void ()>& f);
         
         //! Pushes one transformation onto the transformation stack.
         static void transform(const Transform& transform,
-                              const std::function<void()>& f);
+                              const std::function<void ()>& f);
 
         //! Draws a line from one point to another (last pixel exclusive).
         //! Note: OpenGL lines are not reliable at all and may have a missing pixel at the start

data/Gosu/Version.hpp

@@ -4,7 +4,7 @@
 
 #define GOSU_MAJOR_VERSION 0
 #define GOSU_MINOR_VERSION 12
-#define GOSU_POINT_VERSION 0
+#define GOSU_POINT_VERSION 1
 
 namespace Gosu
 {

data/lib/gosu.rb

@@ -1,14 +1,22 @@
-require "rbconfig"
+require 'rbconfig'
 
 if RUBY_PLATFORM =~ /mswin$|mingw32|mingw64|win32\-|\-win32/
   binary_path = File.dirname(__FILE__)
   # 64-bit builds of Windows use "x64-mingw32" as RUBY_PLATFORM
   binary_path += "64" if RUBY_PLATFORM =~ /^x64-/
   
-  # Add this gem to the PATH on Windows so that bundled DLLs can be found.
-  # When running through Ocra on Windows, we need to be careful to preserve the ENV["PATH"]
-  # encoding (see #385).
-  ENV["PATH"] = "#{binary_path.encode ENV["PATH"].encoding};#{ENV["PATH"]}"
+  begin
+    # Make DLLs available as shown here:
+	# https://github.com/oneclick/rubyinstaller2/wiki/For-gem-developers
+    require 'ruby_installer'
+    RubyInstaller::Runtime.add_dll_directory(binary_path)
+  rescue LoadError
+    # Add this gem to the PATH on Windows so that bundled DLLs can be found.
+    # When running through Ocra on Windows, we need to be careful to preserve the ENV["PATH"]
+    # encoding (see #385).
+	path_encoding = ENV["PATH"].encoding
+    ENV["PATH"] = "#{binary_path.encode(path_encoding)};#{ENV["PATH"]}"
+  end
   
   # Add the correct lib directory for the current version of Ruby (major.minor).
   $LOAD_PATH.unshift File.join(binary_path, RUBY_VERSION[/^\d+.\d+/])

data/rdoc/gosu.rb

@@ -506,12 +506,10 @@ module Gosu
     ##
     # Plays the sample without panning.
     #
-    # Playback speed is limited only by the underlying audio library, and both very large and very small values should work just fine.
-    #
     # @return [SampleInstance]
-    # @param volume [Float] the playback volume, in the range [0.0; 1.0], where 0 is completely silent and 1 is full volume.
-    # @param speed [Float] the playback speed.
-    # @param looping [true, false] whether the sample should play in a loop.
+    # @param volume [Float] see {SampleInstance#volume=}
+    # @param speed [Float] see {SampleInstance#speed=}
+    # @param looping [true, false] whether the sample should play in a loop. If you pass true, be sure to store the return value of this method so that you can later stop the looping sound.
     #
     # @see #play_pan
     def play(volume=1, speed=1, looping=false); end
@@ -519,11 +517,11 @@ module Gosu
     ##
     # Plays the sample with panning.
     #
-    # @note Samples played with this method will not be as loud as those played with {#play}, even if `pan` is 0. This is due to a limitation in the way panning works.
-    #
     # @return [SampleInstance]
-    # @param pan [Float] the amount of panning. 0.0 is centered.
-    # @param (see #play)
+    # @param pan [Float] see {SampleInstance#pan=}
+    # @param volume [Float] see {SampleInstance#volume=}
+    # @param speed [Float] see {SampleInstance#speed=}
+    # @param looping [true, false] whether the sample should play in a loop. If you pass true, be sure to store the return value of this method so that you can later stop the looping sound.
     #
     # @see #play
     def play_pan(pan=0, volume=1, speed=1, looping=false); end
@@ -534,8 +532,22 @@ module Gosu
   #
   # It is recommended to throw away sample instances as soon as possible, as holding onto them for a long time can prevent unneeded samples being properly disposed.
   class SampleInstance
+    ##
+    # Sets the playback volume, in the range [0.0; 1.0], where 0 is completely silent and 1 is full volume. Values outside of this range will be clamped to [0.0; 1.0].
+    # @param [Float]
+    # @return [Float]
     attr_writer :volume
+    
+    ##
+    # Sets the playback speed. A value of 2.0 will play the sample at 200% speed and one octave higher. A value of 0.5 will play the sample at 50% speed and one octave lower. The valid range of this property depends on the operating system, but values up to 8.0 should work.
+    # @param [Float]    
+    # @return [Float]
     attr_writer :speed
+    
+    ##
+    # Set the amount of panning, i.e. the position of the sound when using stereo speakers. 0.0 is the centre, negative values are to the left, positive values are to the right. If something happens on the edge of the screen, a good value for pan would be ±0.1.
+    # @param [Float] 
+    # @return [Float]
     attr_writer :pan
 
     ##

data/src/Audio.cpp

@@ -124,7 +124,7 @@ void Gosu::SampleInstance::change_volume(double volume)
     ALuint source = al_channel_management->source_if_still_playing(handle, extra);
     if (source == ALChannelManagement::NO_SOURCE) return;
     
-    alSourcef(source, AL_GAIN, volume);
+    alSourcef(source, AL_GAIN, max(volume, 0.0));
 }
 
 void Gosu::SampleInstance::change_pan(double pan)
@@ -171,7 +171,7 @@ private:
     SampleData& operator=(const SampleData&);
 };
 
-Gosu::Sample::Sample(const std::string& filename)
+Gosu::Sample::Sample(const string& filename)
 {
     CONSTRUCTOR_BEGIN;
 
@@ -201,12 +201,13 @@ Gosu::Sample::Sample(Reader reader)
             WAVE_FILE audio_file(reader);
             data.reset(new SampleData(audio_file));
         }
-        catch (const std::runtime_error& ex) {
+        catch (const runtime_error& ex) {
         #ifndef GOSU_IS_MAC
-            if (std::string(ex.what()).find("unknown format") != std::string::npos) {
+            if (string(ex.what()).find("unknown format") != string::npos) {
                 MPEGFile mpeg_file(reader);
                 data.reset(new SampleData(mpeg_file));
-            } else
+            }
+            else
         #endif
                 throw ex;
         }
@@ -223,7 +224,7 @@ Gosu::SampleInstance Gosu::Sample::play(double volume, double speed, bool loopin
 Gosu::SampleInstance Gosu::Sample::play_pan(double pan, double volume, double speed,
     bool looping) const
 {
-    std::pair<int, int> channel_and_token = al_channel_management->reserve_channel();
+    pair<int, int> channel_and_token = al_channel_management->reserve_channel();
     if (channel_and_token.first == ALChannelManagement::NO_FREE_CHANNEL) {
         return Gosu::SampleInstance(channel_and_token.first, channel_and_token.second);
     }
@@ -233,7 +234,7 @@ Gosu::SampleInstance Gosu::Sample::play_pan(double pan, double volume, double sp
     assert (source != ALChannelManagement::NO_SOURCE);
     alSourcei(source, AL_BUFFER, data->buffer);
     alSource3f(source, AL_POSITION, pan * 10, 0, 0);
-    alSourcef(source, AL_GAIN, volume);
+    alSourcef(source, AL_GAIN, max(volume, 0.0));
     alSourcef(source, AL_PITCH, speed);
     alSourcei(source, AL_LOOPING, looping ? AL_TRUE : AL_FALSE);
     alSourcePlay(source);
@@ -285,7 +286,7 @@ class Gosu::Song::ModuleData : public BaseData
     }
     
 public:
-    ModuleData(const std::string& filename)
+    ModuleData(const string& filename)
     {
         NSURL* URL = [NSURL fileURLWithPath:[NSString stringWithUTF8String:filename.c_str()]];
         player = [[AVAudioPlayer alloc] initWithContentsOfURL:URL error:nil];
@@ -330,14 +331,14 @@ public:
 // AudioFile impl
 class Gosu::Song::StreamData : public BaseData
 {
-    std::unique_ptr<AudioFile> file;
+    unique_ptr<AudioFile> file;
     ALuint buffers[2];
     
     void apply_volume() override
     {
         int source = lookup_source();
         if (source != ALChannelManagement::NO_SOURCE) {
-            alSourcef(source, AL_GAIN, volume());
+            alSourcef(source, AL_GAIN, max(volume(), 0.0));
         }
     }
     
@@ -354,7 +355,7 @@ class Gosu::Song::StreamData : public BaseData
         static const unsigned BUFFER_SIZE = 4096 * 8;
         #endif
         char audio_data[BUFFER_SIZE];
-        std::size_t read_bytes = file->read_data(audio_data, BUFFER_SIZE);
+        size_t read_bytes = file->read_data(audio_data, BUFFER_SIZE);
         if (read_bytes > 0) {
             alBufferData(buffer, file->format(), audio_data,
                          static_cast<ALsizei>(read_bytes), file->sample_rate());
@@ -363,7 +364,7 @@ class Gosu::Song::StreamData : public BaseData
     }
     
 public:
-    StreamData(const std::string& filename)
+    StreamData(const string& filename)
     {
         if (is_ogg_file(filename)) {
             Gosu::File source_file(filename);
@@ -373,9 +374,9 @@ public:
             try {
                 file.reset(new WAVE_FILE(filename));
             }
-            catch (const std::runtime_error& ex) {
+            catch (const runtime_error& ex) {
             #ifndef GOSU_IS_MAC
-                if (std::string(ex.what()).find("unknown format") != std::string::npos) {
+                if (string(ex.what()).find("unknown format") != string::npos) {
                     Gosu::File source_file(filename);
                     file.reset(new MPEGFile(source_file.front_reader()));
                 }
@@ -396,9 +397,9 @@ public:
             try {
                 file.reset(new WAVE_FILE(reader));
             }
-            catch (const std::runtime_error& ex) {
+            catch (const runtime_error& ex) {
             #ifndef GOSU_IS_MAC
-                if (std::string(ex.what()).find("unknown format") != std::string::npos) {
+                if (string(ex.what()).find("unknown format") != string::npos) {
                     file.reset(new MPEGFile(reader));
                 }
                 else
@@ -421,7 +422,7 @@ public:
         int source = lookup_source();
         if (source != ALChannelManagement::NO_SOURCE) {
             alSource3f(source, AL_POSITION, 0, 0, 0);
-            alSourcef(source, AL_GAIN, volume());
+            alSourcef(source, AL_GAIN, max(volume(), 0.0));
             alSourcef(source, AL_PITCH, 1);
             alSourcei(source, AL_LOOPING, AL_FALSE); // need to implement this manually...
 
@@ -521,7 +522,7 @@ public:
     }
 };
 
-Gosu::Song::Song(const std::string& filename)
+Gosu::Song::Song(const string& filename)
 {
 #ifdef GOSU_IS_IPHONE
     if (has_extension(filename, ".mp3") ||

data/src/Color.cpp

@@ -32,7 +32,8 @@ namespace
         // Hue.
         if (delta == 0) {
             hsv.h = 0;
-        } else if (r == max) {
+        }
+        else if (r == max) {
             hsv.h = (g - b) / delta + (g < b ? 6 : 0);
         }
         else if (g == max) {

data/src/Graphics.cpp

@@ -141,7 +141,7 @@ void Gosu::Graphics::set_resolution(unsigned virtual_width, unsigned virtual_hei
     pimpl->update_base_transform();
 }
 
-void Gosu::Graphics::frame(const std::function<void()>& f)
+void Gosu::Graphics::frame(const std::function<void ()>& f)
 {
     if (current_graphics_pointer != nullptr) {
         throw std::logic_error("Cannot nest calls to Gosu::Graphics::begin()");
@@ -222,7 +222,7 @@ void Gosu::Graphics::flush()
     current_queue().clear_queue();
 }
 
-void Gosu::Graphics::gl(const std::function<void()>& f)
+void Gosu::Graphics::gl(const std::function<void ()>& f)
 {
     if (current_queue().recording()) {
         throw std::logic_error("Custom OpenGL is not allowed while creating a macro");
@@ -258,7 +258,7 @@ void Gosu::Graphics::gl(Gosu::ZPos z, const std::function<void ()>& f)
 }
 
 void Gosu::Graphics::clip_to(double x, double y, double width, double height,
-                             const std::function<void()>& f)
+                             const std::function<void ()>& f)
 {
     double screen_height = current_graphics().pimpl->phys_height;
     current_queue().begin_clipping(x, y, width, height, screen_height);
@@ -267,7 +267,7 @@ void Gosu::Graphics::clip_to(double x, double y, double width, double height,
 }
 
 std::unique_ptr<Gosu::ImageData> Gosu::Graphics::record(int width, int height,
-                                                        const std::function<void()>& f)
+                                                        const std::function<void ()>& f)
 {
     queues.resize(queues.size() + 1);
     current_queue().set_recording();
@@ -280,7 +280,7 @@ std::unique_ptr<Gosu::ImageData> Gosu::Graphics::record(int width, int height,
 }
 
 void Gosu::Graphics::transform(const Gosu::Transform& transform,
-                               const std::function<void()>& f)
+                               const std::function<void ()>& f)
 {
     current_queue().push_transform(transform);
     f();

data/src/Input.cpp

@@ -19,7 +19,7 @@ static void require_sdl_video()
         std::atexit([] { SDL_QuitSubSystem(SDL_INIT_VIDEO); });
     }
 }
-    
+
 static std::array<bool, Gosu::NUM_BUTTONS> button_states = { { false } };
 
 struct Gosu::Input::Impl

data/src/LargeImageData.cpp

@@ -13,7 +13,7 @@ Gosu::LargeImageData::LargeImageData(const Bitmap& source, int tile_width, int t
     tiles_x = static_cast<int>(ceil(1.0 * w / tile_width));
     tiles_y = static_cast<int>(ceil(1.0 * h / tile_height));
 
-    // When there are no tiles, set both fields to 0 to avoid entering any for() loop in this class.
+    // When there are no tiles, set both fields to 0 to avoid entering any for () loop in this class.
     if (tiles_x == 0 || tiles_y == 0) {
         tiles_x = tiles_y = 0;
     }

data/src/RubyGosu.cxx

@@ -11627,7 +11627,7 @@ SWIGEXPORT void Init_gosu(void) {
   rb_define_const(mGosu, "LICENSES", SWIG_From_std_string(static_cast< std::string >(Gosu::LICENSES)));
   rb_define_const(mGosu, "MAJOR_VERSION", SWIG_From_int(static_cast< int >(0)));
   rb_define_const(mGosu, "MINOR_VERSION", SWIG_From_int(static_cast< int >(12)));
-  rb_define_const(mGosu, "POINT_VERSION", SWIG_From_int(static_cast< int >(0)));
+  rb_define_const(mGosu, "POINT_VERSION", SWIG_From_int(static_cast< int >(1)));
   rb_define_module_function(mGosu, "milliseconds", VALUEFUNC(_wrap_milliseconds), -1);
   rb_define_module_function(mGosu, "random", VALUEFUNC(_wrap_random), -1);
   rb_define_module_function(mGosu, "degrees_to_radians", VALUEFUNC(_wrap_degrees_to_radians), -1);

data/src/Window.cpp

@@ -260,7 +260,7 @@ bool Gosu::Window::tick()
                 break;
             }
             case (SDL_DROPFILE): {
-                char* dropped_filedir = e.drop.file;      
+                char* dropped_filedir = e.drop.file;
                 if (dropped_filedir == nullptr) break;
                 drop(std::string(dropped_filedir));
                 SDL_free(dropped_filedir);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosu
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Julian Raschke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies: []
 description: |2
       2D game development library.