gosu 0.14.6.pre1 → 1.0.0.pre2

data/rdoc/gosu.rb

@@ -32,6 +32,10 @@ module Gosu
   KB_DOWN = :an_integer
   KB_END = :an_integer
 
+  KB_PRINT_SCREEN = :an_integer
+  KB_SCROLL_LOCK = :an_integer
+  KB_PAUSE = :an_integer
+
   ##
   # This is the key on the numpad.
   KB_ENTER = :an_integer
@@ -71,6 +75,7 @@ module Gosu
   KB_RIGHT_SHIFT = :an_integer
   KB_SEMICOLON = :an_integer
   KB_SLASH = :an_integer
+  KB_CAPS_LOCK = :an_integer
   KB_SPACE = :an_integer
   KB_TAB = :an_integer
   KB_UP = :an_integer
@@ -83,12 +88,32 @@ module Gosu
   MS_OTHER_0…MS_OTHER_7 = :an_integer
 
   GP_BUTTON_0…GP_BUTTON_15 = :an_integer
+  GP_LEFT_STICK_X_AXIS = :an_integer
+  GP_RIGHT_STICK_X_AXIS = :an_integer
+  GP_LEFT_STICK_Y_AXIS = :an_integer
+  GP_RIGHT_STICK_Y_AXIS = :an_integer
+  GP_LEFT_TRIGGER_AXIS = :an_integer
+  GP_RIGHT_TRIGGER_AXIS = :an_integer
+  GP_DPAD_DOWN = :an_integer
+  GP_DPAD_LEFT = :an_integer
+  GP_DPAD_RIGHT = :an_integer
+  GP_DPAD_UP = :an_integer
   GP_DOWN = :an_integer
   GP_LEFT = :an_integer
   GP_RIGHT = :an_integer
   GP_UP = :an_integer
 
   GP_0_BUTTON_0…GP_3_BUTTON_15 = :an_integer
+  GP_0_LEFT_STICK_X_AXIS…GP_3_LEFT_STICK_X_AXIS = :an_integer
+  GP_0_RIGHT_STICK_X_AXIS…GP_3_RIGHT_STICK_X_AXIS = :an_integer
+  GP_0_LEFT_STICK_Y_AXIS…GP_3_LEFT_STICK_Y_AXIS = :an_integer
+  GP_0_RIGHT_STICK_Y_AXIS…GP_3_RIGHT_STICK_Y_AXIS = :an_integer
+  GP_0_LEFT_TRIGGER_AXIS…GP_3_LEFT_TRIGGER_AXIS = :an_integer
+  GP_0_RIGHT_TRIGGER_AXIS…GP_3_RIGHT_TRIGGER_AXIS = :an_integer
+  GP_0_DPAD_DOWN…GP_3_DPAD_DOWN = :an_integer
+  GP_0_DPAD_LEFT…GP_3_DPAD_LEFT = :an_integer
+  GP_0_DPAD_RIGHT…GP_3_DPAD_RIGHT = :an_integer
+  GP_0_DPAD_UP…GP_3_DPAD_UP = :an_integer
   GP_0_DOWN…GP_3_DOWN = :an_integer
   GP_0_LEFT…GP_3_LEFT = :an_integer
   GP_0_RIGHT…GP_3_RIGHT = :an_integer
@@ -190,11 +215,20 @@ module Gosu
 
     # @!endgroup
 
-    # Returns a 32-bit representation of the color suitable for use with OpenGL calls. This color is stored in a fixed order in memory and its integer value may vary depending on your system's byte order.
+    ##
+    # @return [Integer] a 32-bit representation of the color in 0xAARRGGBB format.
+    def argb; end
+
+    alias_method :to_i, :argb
+
+    # Returns a 32-bit representation of the color suitable for use with OpenGL calls. This color is stored in a fixed format in memory and its integer value may vary depending on your system's byte order.
     #
     # @return [Integer] a 32-bit OpenGL color.
     def gl; end
 
+    # Returns an OpenGL integer constant that identifies the RGBA color format that Gosu uses.
+    GL_FORMAT = :some_integer
+
     ##
     # @return [Color] a copy of the color.
     def dup; end
@@ -307,7 +341,7 @@ module Gosu
     # @return [Integer] the width of the text, in pixels.
     # @param text [String]
     def text_width(text, scale_x=1); end
-    
+
     ##
     # Like {#text_width}, but supports the following markup tags: `<b>bold</b>`, `<i>italic</i>`, `<c=rrggbb>colors</c>`.
     def markup_width(markup, scale_x=1); end
@@ -348,6 +382,14 @@ module Gosu
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#tileability Tileability explained in the Gosu Wiki
     def initialize(source, options = {}); end
 
+    ##
+    # Creates a new image with the given dimensions and RGBA pixel data.
+    #
+    # @param [Integer] width Width of the image in pixels.
+    # @param [Integer] height Height of the image in pixels.
+    # @param [String] rgba A string containing raw binary image data, with either one byte ('uint8') or four bytes ('float') per RGBA component.
+    def self.from_blob(width, height, rgba = "\0\0\0\0" * (width * height)); end
+
     ##
     # Creates a reusable image from one or more lines of text.
     #
@@ -403,13 +445,13 @@ module Gosu
 
     ##
     # Returns an image that is a smaller, rectangular view of this {Image}.
-    # 
+    #
     # This is a very fast operation, and no new textures will be allocated.
     # If you update this {Image} or the {#subimage} using {#insert}, the other {Image} will be affected as well.
-    # 
+    #
     # Caveats:
     # * If you stretch or rotate a {#subimage}, the pixels adjacent to it might bleed into it, as Gosu does not manage the 'tileability' of subimages.
-    # 
+    #
     # @return [Image?] an image that represents a portion of the containing image
     def subimage(left, top, width, height); end
 
@@ -433,7 +475,7 @@ module Gosu
     # @see #draw_as_quad
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#drawing-with-colours Drawing with colors, explained in the Gosu Wiki
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#z-ordering Z-ordering explained in the Gosu Wiki
-    def draw(x, y, z, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+    def draw(x, y, z=0, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
 
     ##
     # Draws the image rotated, with its rotational center at (x, y).
@@ -447,7 +489,7 @@ module Gosu
     # @see #draw
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#drawing-with-colours Drawing with colors, explained in the Gosu Wiki
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#z-ordering Z-ordering explained in the Gosu Wiki
-    def draw_rot(x, y, z, angle, center_x=0.5, center_y=0.5, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+    def draw_rot(x, y, z=0, angle=0, center_x=0.5, center_y=0.5, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
 
     ##
     # Draws the image as an arbitrary quad. This method can be used for advanced non-rectangular drawing techniques, e.g., faking perspective or isometric projection.
@@ -559,16 +601,16 @@ module Gosu
     # @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]    
+    # @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] 
+    # @param [Float]
     # @return [Float]
     attr_writer :pan
 
@@ -764,7 +806,7 @@ module Gosu
     ##
     # Toggles between windowed mode and fullscreen.
     attr_writer :fullscreen
-    
+
     ##
     # @return [true, false] whether this window is resizable.
     def resizable?; end
@@ -778,7 +820,7 @@ module Gosu
     #
     # Resizable fullscreen windows always use the full desktop resolution.
     # Windows that are larger than the desktop resolution will be shrunk.
-    # 
+    #
     # @overload initialize(width, height, options = {})
     # @overload initialize(width, height, fullscreen, update_interval = 16.666666)
     #
@@ -795,18 +837,18 @@ module Gosu
     #
     # @return [void]
     def show; end
-    
+
     ##
     # EXPERIMENTAL - MAY DISAPPEAR WITHOUT WARNING.
-    # 
+    #
     # Performs a single step in the main loop.
     # This can be useful for integrating Gosu with other libraries that have their own main loop, e.g. Ruby/Tk.
-    # 
+    #
     # See: https://www.libgosu.org/cgi-bin/mwf/topic_show.pl?tid=1218
-    # 
+    #
     # If you find a good way to use {#tick}, please let us know on the forum and we can make this a part of Gosu's stable interface.
     # Thank you!
-    # 
+    #
     # @return [true, false] whether the {Window} should still be shown after this tick
     def tick; end
 
@@ -833,7 +875,7 @@ module Gosu
     def draw; end
 
     ##
-    # This method can be overriden to give the game a chance to opt out of a call to {#draw}; however, the operating system can still force a redraw for any reason.
+    # This method can be overridden to give the game a chance to opt out of a call to {#draw}; however, the operating system can still force a redraw for any reason.
     #
     # @return [true, false] whether the window needs to be redrawn.
     #
@@ -841,7 +883,8 @@ module Gosu
     def needs_redraw?; end
 
     ##
-    # This method can be overriden to control the visibility of the system cursor over your window, e.g., for level editors or other situations where introducing a custom cursor or hiding the default one is not desired.
+    # This method can be overridden to control the visibility of the system cursor over your window.
+    # The base class implementation returns true.
     #
     # @return [true, false] whether the system cursor should be shown.
     def needs_cursor?; end
@@ -854,7 +897,7 @@ module Gosu
     #
     # @return [bool]
     def close; end
-    
+
     ##
     # This method is called before {#update} if a button is pressed while the window has focus.
     #
@@ -886,6 +929,24 @@ module Gosu
     # @param filename [String] the filename of the dropped file. When multiple files are dropped, this method will be called several times.
     def drop(filename); end
 
+    ##
+    # Called when a gamepad is connected.
+    # If a gamepad is momentarily disconnected and then reconnected, before another gamepad, it will have the same index.
+    #
+    # @param index [integer] index for looking up gamepad.
+    #
+    # @see Gosu.gamepad_name
+    def gamepad_connected(index); end
+
+    ##
+    # Called when a gamepad is disconnected.
+    #
+    # @param index [integer] index for looking up gamepad.
+    #
+    # @see #gamepad_connected
+    # @see Gosu.gamepad_name
+    def gamepad_disconnected(index); end
+
     # @!endgroup
   end
 
@@ -928,6 +989,38 @@ module Gosu
     # @see Window#button_up
     def button_down?(id); end
 
+    ##
+    # Returns the name of a Gosu::KB_{*} constant. Returns nil if no name is found.
+    #
+    # @example
+    #   Gosu.button_name(Gosu::KB_SPACE) #=> "Space"
+    #
+    # @return [String, nil]
+    # @param id [Integer]
+    #
+    def button_name(id); end
+
+    ##
+    # Returns the name for gamepad at `index` or nil if there is no connected at the specified index.
+    #
+    # @example
+    #   Gosu.gamepad_name(0) #=> "PS4 Controller"
+    #
+    # @return [String, nil]
+    # @param index [Integer]
+    def gamepad_name(index); end
+
+    ##
+    # Returns the value for the specified gamepad axis in the range -1.0..1.0 for joysticks and 0.0..1.0 for triggers.
+    #
+    # @example
+    #   Gosu.axis(Gosu::GP_0_LEFT_STICK_Y_AXIS) #=> 0.75
+    #
+    # @return [Float]
+    # @param id [Integer]
+    #
+    def axis(id); end
+
     # @!group Drawing primitives
 
     ##

data/src/Audio.cpp

@@ -1,51 +1,25 @@
 #include "AudioImpl.hpp"
-#include "OggFile.hpp"
+#include "AudioFile.hpp"
+
 #include <Gosu/Audio.hpp>
 #include <Gosu/Math.hpp>
 #include <Gosu/IO.hpp>
 #include <Gosu/Platform.hpp>
 #include <Gosu/Utility.hpp>
+
 #include <cassert>
 #include <cstdlib>
 #include <algorithm>
-
-#ifdef GOSU_IS_MAC
-#import <Foundation/Foundation.h>
-#include "AudioToolboxFile.hpp"
-#else
-#include "MPEGFile.hpp"
-#include "SndFile.hpp"
-#endif
-
-#ifdef GOSU_IS_IPHONE
-#import <AVFoundation/AVFoundation.h>
-#endif
-
 using namespace std;
 
-static bool is_ogg_file(Gosu::Reader reader)
-{
-    if (reader.resource().size() < 4) return false;
-    
-    char bytes[4];
-    reader.read(bytes, 4);
-    return bytes[0] == 'O' && bytes[1] == 'g' && bytes[2] == 'g' && bytes[3] == 'S';
-}
-
-static bool is_ogg_file(const string& filename)
-{
-    Gosu::File file(filename);
-    return is_ogg_file(file.front_reader());
-}
-
 static Gosu::Song* cur_song = nullptr;
 static bool cur_song_looping;
 
-struct Gosu::Sample::SampleData
+struct Gosu::Sample::Impl
 {
     ALuint buffer;
 
-    SampleData(AudioFile&& audio_file)
+    Impl(AudioFile&& audio_file)
     {
         al_initialize();
         alGenBuffers(1, &buffer);
@@ -54,7 +28,7 @@ struct Gosu::Sample::SampleData
                      audio_file.sample_rate());
     }
     
-    ~SampleData()
+    ~Impl()
     {
         // It's hard to free things in the right order in Ruby/Gosu.
         // Make sure buffer isn't deleted after the context/device are shut down.
@@ -70,43 +44,12 @@ Gosu::Sample::Sample()
 
 Gosu::Sample::Sample(const string& filename)
 {
-    if (is_ogg_file(filename)) {
-        File file(filename);
-        data.reset(new SampleData(OggFile(file.front_reader())));
-        return;
-    }
-    
-#ifdef GOSU_IS_MAC
-    File file(filename);
-    data.reset(new SampleData(AudioToolboxFile(file.front_reader())));
-#else
-    try {
-        data.reset(new SampleData(SndFile(filename)));
-    }
-    catch (const runtime_error& ex) {
-        File file(filename);
-        data.reset(new SampleData(MPEGFile(file.front_reader())));
-    }
-#endif
+    pimpl.reset(new Impl(AudioFile(filename)));
 }
 
 Gosu::Sample::Sample(Gosu::Reader reader)
 {
-    if (is_ogg_file(reader)) {
-        data.reset(new SampleData(OggFile(reader)));
-        return;
-    }
-
-#ifdef GOSU_IS_MAC
-    data.reset(new SampleData(AudioToolboxFile(reader)));
-#else
-    try {
-        data.reset(new SampleData(SndFile(reader)));
-    }
-    catch (const runtime_error& ex) {
-        data.reset(new SampleData(MPEGFile(reader)));
-    }
-#endif
+    pimpl.reset(new Impl(AudioFile(reader)));
 }
 
 Gosu::Channel Gosu::Sample::play(double volume, double speed, bool looping) const
@@ -116,7 +59,7 @@ Gosu::Channel Gosu::Sample::play(double volume, double speed, bool looping) cons
 
 Gosu::Channel Gosu::Sample::play_pan(double pan, double volume, double speed, bool looping) const
 {
-    if (!data) return Channel();
+    if (!pimpl) return Channel();
 
     Channel channel = allocate_channel();
     
@@ -124,7 +67,7 @@ Gosu::Channel Gosu::Sample::play_pan(double pan, double volume, double speed, bo
     if (channel.current_channel() == NO_CHANNEL) return channel;
     
     ALuint source = al_source_for_channel(channel.current_channel());
-    alSourcei(source, AL_BUFFER, data->buffer);
+    alSourcei(source, AL_BUFFER, pimpl->buffer);
     alSource3f(source, AL_POSITION, pan * 10, 0, 0);
     alSourcef(source, AL_GAIN, max(volume, 0.0));
     alSourcef(source, AL_PITCH, speed);
@@ -133,112 +76,22 @@ Gosu::Channel Gosu::Sample::play_pan(double pan, double volume, double speed, bo
     return channel;
 }
 
-class Gosu::Song::BaseData
-{
-    BaseData(const BaseData&) = delete;
-    BaseData& operator=(const BaseData&) = delete;
-    
-    double volume_;
-
-protected:
-    BaseData() : volume_(1) {}
-    virtual void apply_volume() = 0;
-
-public:
-    virtual ~BaseData() {}
-    virtual void play(bool looping) = 0;
-    virtual void pause() = 0;
-    virtual void resume() = 0;
-    virtual bool paused() const = 0;
-    virtual void stop() = 0;
-    virtual void update() = 0;
-    
-    double volume() const
-    {
-        return volume_;
-    }
-    
-    void set_volume(double volume)
-    {
-        volume_ = clamp(volume, 0.0, 1.0);
-        apply_volume();
-    }
-};
-
-#ifdef GOSU_IS_IPHONE
-// AVAudioPlayer impl
-class Gosu::Song::ModuleData : public BaseData
-{
-    AVAudioPlayer* player;
-    
-    void apply_volume() override
-    {
-        player.volume = volume();
-    }
-    
-public:
-    ModuleData(const string& filename)
-    {
-        NSURL* URL = [NSURL fileURLWithPath:[NSString stringWithUTF8String:filename.c_str()]];
-        player = [[AVAudioPlayer alloc] initWithContentsOfURL:URL error:nil];
-    }
-    
-    void play(bool looping) override
-    {
-        if (paused()) {
-            stop();
-        }
-        player.numberOfLoops = looping ? -1 : 0;
-        [player play];
-    }
-    
-    void pause() override
-    {
-        [player pause];
-    }
-    
-    void resume() override
-    {
-        [player play];
-    }
-    
-    bool paused() const override
-    {
-        return !player.playing;
-    }
-    
-    void stop() override
-    {
-        [player stop];
-        player.currentTime = 0;
-    }
-    
-    void update() override
-    {
-    }
-};
-#endif
-
 // AudioFile impl
-class Gosu::Song::StreamData : public BaseData
+struct Gosu::Song::Impl
 {
+    double volume_ = 1.0;
     unique_ptr<AudioFile> file;
     ALuint buffers[2];
     
-    void apply_volume() override
+    void apply_volume()
     {
         alSourcef(al_source_for_songs(), AL_GAIN, max(volume(), 0.0));
     }
     
     bool stream_to_buffer(ALuint buffer)
     {
-        #ifdef GOSU_IS_IPHONE
-        static const unsigned BUFFER_SIZE = 4096 * 4;
-        #else
-        static const unsigned BUFFER_SIZE = 4096 * 8;
-        #endif
-        char audio_data[BUFFER_SIZE];
-        size_t read_bytes = file->read_data(audio_data, BUFFER_SIZE);
+        char audio_data[4096 * 8];
+        size_t read_bytes = file->read_data(audio_data, sizeof audio_data);
         if (read_bytes > 0) {
             alBufferData(buffer, file->format(), audio_data,
                          static_cast<ALsizei>(read_bytes), file->sample_rate());
@@ -247,53 +100,23 @@ class Gosu::Song::StreamData : public BaseData
     }
     
 public:
-    StreamData(const string& filename)
+    explicit Impl(const string& filename)
     {
-        if (is_ogg_file(filename)) {
-            File source_file(filename);
-            file.reset(new OggFile(source_file.front_reader()));
-        }
-        else {
-        #ifdef GOSU_IS_MAC
-            file.reset(new AudioToolboxFile(filename));
-        #else
-            try {
-                file.reset(new SndFile(filename));
-            }
-            catch (const runtime_error& ex) {
-                File source_file(filename);
-                file.reset(new MPEGFile(source_file.front_reader()));
-            }
-        #endif
-        }
-        
+        file.reset(new AudioFile(filename));
+
         al_initialize();
         alGenBuffers(2, buffers);
     }
 
-    StreamData(Reader reader)
+    explicit Impl(Reader reader)
     {
-        if (is_ogg_file(reader)) {
-            file.reset(new OggFile(reader));
-        }
-        else {
-        #ifdef GOSU_IS_MAC
-            file.reset(new AudioToolboxFile(reader));
-        #else
-            try {
-                file.reset(new SndFile(reader));
-            }
-            catch (const runtime_error& ex) {
-                file.reset(new MPEGFile(reader));
-            }
-        #endif
-        }
-        
+        file.reset(new AudioFile(reader));
+
         al_initialize();
         alGenBuffers(2, buffers);
     }
     
-    ~StreamData()
+    ~Impl()
     {
         // It's hard to free things in the right order in Ruby/Gosu.
         // Make sure buffers aren't deleted after the context/device are shut down.
@@ -302,7 +125,7 @@ public:
         alDeleteBuffers(2, buffers);
     }
     
-    void play(bool looping) override
+    void play(bool looping)
     {
         ALuint source = al_source_for_songs();
 
@@ -319,7 +142,7 @@ public:
         alSourcePlay(source);
     }
 
-    void stop() override
+    void stop()
     {
         ALuint source = al_source_for_songs();
 
@@ -338,24 +161,24 @@ public:
         file->rewind();
     }
     
-    void pause() override
+    void pause()
     {
         alSourcePause(al_source_for_songs());
     }
     
-    void resume() override
+    void resume()
     {
         alSourcePlay(al_source_for_songs());
     }
     
-    bool paused() const override
+    bool paused() const
     {
         ALint state;
         alGetSourcei(al_source_for_songs(), AL_SOURCE_STATE, &state);
         return state == AL_PAUSED;
     }
     
-    void update() override
+    void update()
     {
         ALuint source = al_source_for_songs();
 
@@ -390,24 +213,27 @@ public:
             }
         }
     }
+    
+    double volume() const
+    {
+        return volume_;
+    }
+    
+    void set_volume(double volume)
+    {
+        volume_ = clamp(volume, 0.0, 1.0);
+        apply_volume();
+    }
 };
 
 Gosu::Song::Song(const string& filename)
 {
-#ifdef GOSU_IS_IPHONE
-    if (has_extension(filename, ".mp3") ||
-            has_extension(filename, ".aac") ||
-            has_extension(filename, ".m4a")) {
-        data.reset(new ModuleData(filename));
-        return;
-    }
-#endif
-    data.reset(new StreamData(filename));
+    pimpl.reset(new Impl(filename));
 }
 
 Gosu::Song::Song(Reader reader)
 {
-    data.reset(new StreamData(reader));
+    pimpl.reset(new Impl(reader));
 }
 
 Gosu::Song::~Song()
@@ -423,7 +249,7 @@ Gosu::Song* Gosu::Song::current_song()
 void Gosu::Song::play(bool looping)
 {
     if (paused()) {
-        data->resume();
+        pimpl->resume();
     }
     
     if (cur_song && cur_song != this) {
@@ -432,7 +258,7 @@ void Gosu::Song::play(bool looping)
     }
     
     if (cur_song == nullptr) {
-        data->play(looping);
+        pimpl->play(looping);
     }
     
     cur_song = this;
@@ -442,41 +268,41 @@ void Gosu::Song::play(bool looping)
 void Gosu::Song::pause()
 {
     if (cur_song == this) {
-        data->pause();
+        pimpl->pause();
     }
 }
 
 bool Gosu::Song::paused() const
 {
-    return cur_song == this && data->paused();
+    return cur_song == this && pimpl->paused();
 }
 
 void Gosu::Song::stop()
 {
     if (cur_song == this) {
-        data->stop();
+        pimpl->stop();
         cur_song = nullptr;
     }
 }
 
 bool Gosu::Song::playing() const
 {
-    return cur_song == this && !data->paused();
+    return cur_song == this && !pimpl->paused();
 }
 
 double Gosu::Song::volume() const
 {
-    return data->volume();
+    return pimpl->volume();
 }
 
 void Gosu::Song::set_volume(double volume)
 {
-    data->set_volume(volume);
+    pimpl->set_volume(volume);
 }
 
 void Gosu::Song::update()
 {
     if (current_song()) {
-        current_song()->data->update();
+        current_song()->pimpl->update();
     }
 }