gosu 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f867c68587f182be0ba872daf669724376a55b6f7e0c3853eca5f350dc413f
-  data.tar.gz: f24639563ba937303f9a81dd22a78ad5a22fa9243d980c629d163605656be0b2
+  metadata.gz: 7d58f7d332c57be8c599f33a6c60df54d7143e6ef2980eacd1a84f5d51f7a26a
+  data.tar.gz: e22cf468c5392985d6429aac77b958d71c63c33ac40a4a06b1f01187837bb224
 SHA512:
-  metadata.gz: 6bb10eafcfa8742066e246e607ada383af5d2f3a461910e386064b27788d5620ab289b2081e0e4652240df9faf7cb1bb8d669fb95b7bcfbfb040e767c4354edd
-  data.tar.gz: dc56b6a28a0f8980027c3f3bc5fd110e806617a4b22b3d6e918fa24f99d59cea98cd03d85af875968bcc7b98bc283ac810aca7a37e199ff1f4aaaaea1de7fc80
+  metadata.gz: 69605aee52675d916c27e58ad596d294ea4268e24520b137a2afa184a38f92b4120646a1e0c3ada0e6293088db9f965adf907a99b164052ee741b81cfd2a779c
+  data.tar.gz: 55615664e9ababb8ee986af01191a296b364d53d42986fcd45a94436b33f4d59aa46643da62a14e0e0a960def6a699d782f03bf74876c70405e4f6ec4d8591df

data/include/Gosu/Color.hpp

@@ -1,6 +1,3 @@
-//! \file Color.hpp
-//! Interface of the Color class.
-
 #pragma once
 
 #include <Gosu/Platform.hpp>
@@ -8,154 +5,105 @@
 
 namespace Gosu
 {
-    //! Represents an RGBA color value with 8 bits for each channel.
-    //! Can be implicitly constructed from literals of the form 0xaarrggbb.
-    //! Has fast value semantics.
-    //! The four-byte layout in memory is RGBA. On Big-Endian machines the unsigned int will look
-    //! like 0xrrggbbaa, on Little-Endian machines it is 0xaabbggrr.
-    class Color
+    /// Represents an RGBA color value with 8 bit for each channel.
+    /// Can be implicitly constructed from literals of the form 0xaarrggbb.
+    struct Color
     {
-        std::uint32_t rep;
-        #ifdef GOSU_IS_LITTLE_ENDIAN
-        enum { RED_OFFSET = 0, GREEN_OFFSET = 8, BLUE_OFFSET = 16, ALPHA_OFFSET = 24 };
-        #else
-        enum { RED_OFFSET = 24, GREEN_OFFSET = 16, BLUE_OFFSET = 8, ALPHA_OFFSET = 0 };
-        #endif
-        
-    public:
-        typedef std::uint8_t Channel;
         static const unsigned GL_FORMAT = 0x1908; // GL_RGBA
-        
-        //! The default constructor does not initialize the color to any value.
-        Color()
-        {
-        }
-        
-        //! Conversion constructor for literals of the form 0xaarrggbb.
-        Color(unsigned argb)
-        : Color((argb >> 24) & 0xff, (argb >> 16) & 0xff, (argb >> 8) & 0xff, (argb >> 0) & 0xff)
-        {
-        }
-        
-        Color(Channel red, Channel green, Channel blue)
-        : Color(0xff, red, green, blue)
-        {
-        }
-        
-        Color(Channel alpha, Channel red, Channel green, Channel blue)
-        {
-            rep = (alpha << ALPHA_OFFSET) | (red << RED_OFFSET) |
-                  (green << GREEN_OFFSET) | (blue << BLUE_OFFSET);
-        }
-        
-        //! Constructs a color from the given hue/saturation/value triple.
-        //! Ranges of these values are given as 0..360, 0..1, and 0..1, respectively.
-        static Color from_hsv(double h, double s, double v);
-        
-        //! Constructs a color from the given hue/saturation/value triple.
-        //! Ranges of these values are given as 0..360, 0..1, and 0..1, respectively.
-        static Color from_ahsv(Channel alpha, double h, double s, double v);
 
-        Channel red() const
-        {
-            return static_cast<Channel>(rep >> RED_OFFSET);
-        }
-
-        Channel green() const
-        {
-            return static_cast<Channel>(rep >> GREEN_OFFSET);
-        }
+        typedef std::uint8_t Channel;
 
-        Channel blue() const
-        {
-            return static_cast<Channel>(rep >> BLUE_OFFSET);
-        }
+        Channel red, green, blue, alpha;
 
-        Channel alpha() const
+        constexpr Color()
+        : red{0}, green{0}, blue{0}, alpha{0}
         {
-            return static_cast<Channel>(rep >> ALPHA_OFFSET);
         }
 
-        void set_red(Channel value)
+        /// Conversion constructor for literals of the form 0xaarrggbb.
+        // NOLINTNEXTLINE: We want to allow implicit conversions.
+        constexpr Color(std::uint32_t argb)
+        : red{static_cast<Channel>(argb >> 16)}, green{static_cast<Channel>(argb >> 8)},
+          blue{static_cast<Channel>(argb >> 0)}, alpha{static_cast<Channel>(argb >> 24)}
         {
-            rep &= ~(0xff << RED_OFFSET);
-            rep |= value << RED_OFFSET;
         }
 
-        void set_green(Channel value)
+        constexpr Color(Channel red, Channel green, Channel blue)
+        : red{red}, green{green}, blue{blue}, alpha{255}
         {
-            rep &= ~(0xff << GREEN_OFFSET);
-            rep |= value << GREEN_OFFSET;
         }
 
-        void set_blue(Channel value)
+        Color with_alpha(Channel new_alpha)
         {
-            rep &= ~(0xff << BLUE_OFFSET);
-            rep |= value << BLUE_OFFSET;
+            Color result = *this;
+            result.alpha = new_alpha;
+            return result;
         }
 
-        void set_alpha(Channel value)
-        {
-            rep &= ~(0xff << ALPHA_OFFSET);
-            rep |= value << ALPHA_OFFSET;
-        }
+        /// Constructs a color from the given hue/saturation/value triple.
+        /// Ranges of these values are given as 0..360, 0..1, and 0..1, respectively.
+        static Color from_hsv(double h, double s, double v);
 
-        //! Returns the hue of the color, in the usual range of 0..360.
+        /// Returns the hue of the color, in the usual range of 0..360.
         double hue() const;
         
-        //! Changes the current color so hue() will return h.
+        /// Changes the current color so hue() will return h.
         void set_hue(double h);
         
-        //! Returns the saturation of the color, in the range of 0..1.
+        /// Returns the saturation of the color, in the range of 0..1.
         double saturation() const;
         
-        //! Changes the current color so saturation() will return s.
+        /// Changes the current color so saturation() will return s.
         void set_saturation(double s);
         
-        //! Returns the value (brightness) of the color, in the range of 0..1.
+        /// Returns the value (brightness) of the color, in the range of 0..1.
         double value() const;
         
-        //! Changes the current color so value() will return v.
+        /// Changes the current color so value() will return v.
         void set_value(double v);
 
-        //! Returns the color in 0xaarrggbb representation.
-        std::uint32_t argb() const { return alpha() << 24 | red() << 16 | green() << 8 | blue(); }
+        /// Returns the color in 0xaarrggbb representation.
+        std::uint32_t argb() const { return alpha << 24 | red << 16 | green << 8 | blue; }
 
-        //! Returns the color in 0x00bbggrr representation. Useful for Win32 programming.
-        std::uint32_t bgr() const { return blue() << 16 | green() << 8 | red(); }
+        /// Returns the color in 0x00bbggrr representation. Useful for Win32 programming.
+        std::uint32_t bgr() const { return blue << 16 | green << 8 | red; }
+
+        /// Returns the color in 0xaabbggrr representation.
+        std::uint32_t abgr() const { return alpha << 24 | blue << 16 | green << 8 | red; }
+
+        /// Returns the internal representation of the color (RGBA in memory).
+        std::uint32_t gl() const { return *reinterpret_cast<const std::uint32_t*>(this); }
 
-        //! Returns the color in 0xaabbggrr representation.
-        std::uint32_t abgr() const { return alpha() << 24 | blue() << 16 | green() << 8 | red(); }
-        
-        //! Returns the internal representation of the color (RGBA in memory).
-        std::uint32_t gl() const { return rep; }
-        
         static const Color NONE;
         static const Color BLACK;
         static const Color GRAY;
         static const Color WHITE;
-        
+
+        /// Same as Color::CYAN.
         static const Color AQUA;
         static const Color RED;
         static const Color GREEN;
         static const Color BLUE;
         static const Color YELLOW;
         static const Color FUCHSIA;
+        /// Same as Color::AQUA.
         static const Color CYAN;
     };
+
+    // Ensure that we can pass vectors of Gosu::Color straight to OpenGL and back.
+    static_assert(sizeof(Color) == sizeof(std::uint32_t));
     
 #ifndef SWIG
     inline bool operator<(Color a, Color b) { return a.gl() < b.gl(); }
     inline bool operator==(Color a, Color b) { return a.gl() == b.gl(); }
     inline bool operator!=(Color a, Color b) { return a.gl() != b.gl(); }
 
-    //! Interpolates linearly between two colors, with a given weight towards
-    //! the second color.
-    //! Specialization of the general function in Gosu/Math.hpp.
-    Color interpolate(Color a, Color b, double weight = 0.5);
+    /// Interpolates linearly between two colors, with a given weight towards
+    /// the second color.
+    Color lerp(Color a, Color b, double t = 0.5);
     
-    //! Combines two colors as if their channels were mapped to the 0..1 range
-    //! and then multiplied with each other.
+    /// Combines two colors as if their channels were mapped to the 0..1 range
+    /// and then multiplied with each other.
     Color multiply(Color a, Color b);
 #endif
 }

data/include/Gosu/Fwd.hpp

@@ -5,7 +5,7 @@ namespace Gosu
     class Bitmap;
     class Buffer;
     class Channel;
-    class Color;
+    struct Color;
     class File;
     class Font;
     class Graphics;

data/include/Gosu/Math.hpp

@@ -67,17 +67,7 @@ namespace Gosu
     {
         return value * value;
     }
-    
-    //! Returns min if value is smaller than min, max if value is larger than
-    //! max and value otherwise.
-    template<typename T>
-    T clamp(T value, T min, T max)
-    {
-        if (value < min) return min;
-        if (value > max) return max;
-        return value;
-    }
-    
+
     //! Returns (value-min) % (max-min) + min, where % always has a positive
     //! result for max > min. The results are undefined for max <= min.
     //! Note: This means that max is exclusive.
@@ -100,12 +90,10 @@ namespace Gosu
     //! Returns the distance between two points.
     double distance(double x1, double y1, double x2, double y2);
     
-    //! Interpolates a value between a and b, weight being the bias towards the second value.
-    //! Examples: interpolate(0, 10, 0.5) == 5, interpolate(-10, 10, 0.25) == 5,
-    //! interpolate(0, 10, -0.5) == -5.
+    //! Placeholder for std::lerp, will be removed when Gosu requires C++20.
     template<typename T>
-    T interpolate(T a, T b, double weight = 0.5)
+    T lerp(T a, T b, double t = 0.5)
     {
-        return a * (1.0 - weight) + b * weight;
+        return a * (1.0 - t) + b * t;
     }
 }

data/include/Gosu/Platform.hpp

@@ -1,51 +1,5 @@
-//! \file Platform.hpp
-//! Macros and utility functions to facilitate programming on all of Gosu's supported platforms.
-
 #pragma once
 
-#ifdef __BIG_ENDIAN__
-# define GOSU_IS_BIG_ENDIAN
-# define IDENTITY_FUN big_to_native
-# define IDENTITY_FUN2 native_to_big
-# define CONV_FUN little_to_native
-# define CONV_FUN2 native_to_little
-#else
-# define GOSU_IS_LITTLE_ENDIAN
-# define IDENTITY_FUN little_to_native
-# define IDENTITY_FUN2 native_to_little
-# define CONV_FUN big_to_native
-# define CONV_FUN2 native_to_big
-#endif
-
-#include <algorithm>
-
-namespace Gosu
-{
-    template<typename T> T IDENTITY_FUN(T t) { return t; }
-    template<typename T> T IDENTITY_FUN2(T t) { return t; }
-    
-    template<typename T>
-    T CONV_FUN(T t)
-    {
-        char* begin = reinterpret_cast<char*>(&t);
-        std::reverse(begin, begin + sizeof t);
-        return t;
-    }
-
-    template<typename T> T CONV_FUN2(T t) { return CONV_FUN(t); }
-}
-
-#undef IDENTITY_FUN
-#undef IDENTITY_FUN2
-#undef CONV_FUN
-#undef CONV_FUN2
-
-#if defined(_MSC_VER)
-# define GOSU_NORETURN __declspec(noreturn)
-#elif defined(__GNUC__)
-# define GOSU_NORETURN __attribute__ ((noreturn))
-#endif
-
 #if defined(WIN32) || defined(_WIN64)
 # define GOSU_IS_WIN
 #else
@@ -63,9 +17,5 @@ namespace Gosu
 #endif
 
 #ifndef GOSU_DEPRECATED
-# if defined(GOSU_IS_WIN)
-#  define GOSU_DEPRECATED __declspec(deprecated)
-# else
-#  define GOSU_DEPRECATED __attribute__((__deprecated__))
-# endif
+# define GOSU_DEPRECATED [[deprecated]]
 #endif

data/include/Gosu/Text.hpp

@@ -1,6 +1,3 @@
-//! \file Text.hpp
-//! Functions to output text on bitmaps.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
@@ -10,55 +7,55 @@
 
 namespace Gosu
 {
-    //! Returns the name of a neutral font that is available on the current platform.
+    /// Returns the name of a neutral font that is available on the current platform.
     std::string default_font_name();
 
-    //! Returns the width an unformatted line of text would span on a bitmap if it were drawn using
-    //! draw_text with the same arguments.
-    //! \param text A UCS-4 string, normalization: NFC.
-    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
+    /// Returns the width that an unformatted line of text would span on a bitmap if it were drawn
+    /// using draw_text with the same arguments.
+    /// @param text A UCS-4 string, normalization: NFC.
+    /// @param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
     double text_width(const std::u32string& text, const std::string& font_name, double font_height,
                       unsigned font_flags = 0);
 
-    //! Draws a line of plain text on a bitmap. This is a low-level function that does not
-    //! understand any of Gosu's HTML-like markup.
-    //! \param text A UCS-4 string, normalization: NFC.
-    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
-    //! \param font_height Height, in pixels, of the text.
-    //! \param font_flags Binary combination of members of the FontFlags enum.
+    /// Draws a line of plain text on a bitmap. This is a low-level function that does not
+    /// understand any of Gosu's HTML-like markup.
+    /// @param text A UCS-4 string, normalization: NFC.
+    /// @param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
+    /// @param font_height Height, in pixels, of the text.
+    /// @param font_flags Binary combination of members of the FontFlags enum.
     double draw_text(Bitmap& bitmap, double x, double y, Color c, const std::u32string& text,
                      const std::string& font_name, double font_height, unsigned font_flags = 0);
 
-    //! Creates a bitmap that is filled with the plain text given to the function.
-    //! The line can contain line breaks and HTML-like markup.
-    //! \param text Plain text.
-    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
-    //! \param font_height Height of the font in pixels.
-    //! \param line_spacing Spacing between two lines of text in pixels. Can be negative to make
-    //!        text stick together more closely.
-    //! \param width Width of the bitmap that will be returned.
-    //!        Text will be split into multiple lines to avoid drawing over the right border.
-    //!        When a single word is too long, it will be truncated.
-    //!        A width smaller than 0 indicates that lines should not be wrapped, and the resulting
-    //!        bitmap will be as wide as the widest line.
-    //! \param font_flags Binary combination of members of the FontFlags enum.
+    /// Creates a bitmap that is filled with the plain text given to the function.
+    /// The line can contain line breaks and HTML-like markup.
+    /// @param text Plain text.
+    /// @param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
+    /// @param font_height Height of the font in pixels.
+    /// @param line_spacing Spacing between two lines of text in pixels. Can be negative to make
+    ///        text stick together more closely.
+    /// @param width Width of the bitmap that will be returned.
+    ///        Text will be split into multiple lines to avoid drawing over the right border.
+    ///        When a single word is too long, it will be truncated.
+    ///        A width smaller than 0 indicates that lines should not be wrapped, and the resulting
+    ///        bitmap will be as wide as the widest line.
+    /// @param font_flags Binary combination of members of the FontFlags enum.
     Bitmap layout_text(const std::string& text, const std::string& font_name,
                        double font_height, double line_spacing = 0,
                        int width = -1, Alignment align = AL_LEFT, unsigned font_flags = 0);
     
-    //! Creates a bitmap that is filled with the formatted text given to the function.
-    //! The line can contain line breaks and HTML-like markup.
-    //! \param markup Formatted text.
-    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
-    //! \param font_height Height of the font in pixels.
-    //! \param line_spacing Spacing between two lines of text in pixels. Can be negative to make
-    //!        text stick together more closely.
-    //! \param width Width of the bitmap that will be returned.
-    //!        Text will be split into multiple lines to avoid drawing over the right border.
-    //!        When a single word is too long, it will be truncated.
-    //!        A width smaller than 0 indicates that lines should not be wrapped, and the resulting
-    //!        bitmap will be as wide as the widest line.
-    //! \param font_flags Binary combination of members of the FontFlags enum.
+    /// Creates a bitmap that is filled with the formatted text given to the function.
+    /// The line can contain line breaks and HTML-like markup.
+    /// @param markup Formatted text.
+    /// @param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
+    /// @param font_height Height of the font in pixels.
+    /// @param line_spacing Spacing between two lines of text in pixels. Can be negative to make
+    ///        text stick together more closely.
+    /// @param width Width of the bitmap that will be returned.
+    ///        Text will be split into multiple lines to avoid drawing over the right border.
+    ///        When a single word is too long, it will be truncated.
+    ///        A width smaller than 0 indicates that lines should not be wrapped, and the resulting
+    ///        bitmap will be as wide as the widest line.
+    /// @param font_flags Binary combination of members of the FontFlags enum.
     Bitmap layout_markup(const std::string& markup, const std::string& font_name,
                          double font_height, double line_spacing = 0,
                          int width = -1, Alignment align = AL_LEFT, unsigned font_flags = 0);

data/include/Gosu/Version.hpp

@@ -3,7 +3,7 @@
 #include <string>
 
 #define GOSU_MAJOR_VERSION 1
-#define GOSU_MINOR_VERSION 2
+#define GOSU_MINOR_VERSION 3
 #define GOSU_POINT_VERSION 0
 
 namespace Gosu

data/include/Gosu/Window.hpp

@@ -89,6 +89,8 @@ namespace Gosu
         //! If this function returns true, the system cursor will be visible while over the window.
         virtual bool needs_cursor() const { return true; }
 
+        virtual void gain_focus() {}
+
         //! This function is called when the window loses focus on some platforms.
         //! Most importantly, it is called on the iPhone or iPad when the user locks the screen.
         virtual void lose_focus() {}

data/lib/gosu/swig_patches.rb

@@ -20,7 +20,7 @@ class Gosu::Window
   end
 
   %w(update draw needs_redraw? needs_cursor?
-     lose_focus button_down button_up
+     gain_focus lose_focus button_down button_up
      gamepad_connected gamepad_disconnected drop).each do |callback|
     define_method "protected_#{callback}" do |*args|
       begin
@@ -35,13 +35,13 @@ class Gosu::Window
       end
     end
   end
-  
+
   def protected_draw_2
     protected_draw
     $gosu_gl_blocks_2 = $gosu_gl_blocks
     $gosu_gl_blocks = nil
   end
-  
+
   alias_method :show_internal, :show
   def show
     show_internal
@@ -54,6 +54,21 @@ class Gosu::Window
       raise @_exception
     end
   end
+
+  alias_method :tick_internal, :tick
+  def tick
+    value = tick_internal
+    # Try to format the message nicely, without any useless patching that we are
+    # doing here.
+    if defined? @_exception
+      if @_exception.backtrace.is_a? Array and not @_exception.backtrace.frozen?
+        @_exception.backtrace.reject! { |line| line.include? "lib/gosu/swig_patches.rb" }
+      end
+      raise @_exception
+    end
+
+    value
+  end
 end
 
 module Gosu
@@ -73,6 +88,19 @@ end
 # SWIG somehow maps the instance method "argb" as an overload of the class
 # method of the same name.
 class Gosu::Color
+  alias_method :initialize_without_argb, :initialize
+
+  # The (a,r,g,b) constructor overload was dropped in C++ to reduce ambiguity,
+  # adding it via %extend in gosu.i does not work, so patch it here.
+  def initialize(*args)
+    if args.size == 4
+      initialize_without_argb(args[1], args[2], args[3])
+      self.alpha = args[0]
+    else
+      initialize_without_argb(*args)
+    end
+  end
+
   alias_method :argb, :to_i
 end
 

data/rdoc/gosu.rb

@@ -481,7 +481,7 @@ module Gosu
     # Draws the image rotated, with its rotational center at (x, y).
     #
     # @return [void]
-    # @param angle [Float]
+    # @param angle [Float] the angle to rotate, in degrees.
     # @param center_x [Float] the relative horizontal rotation origin.
     # @param center_y [Float] the relative vertical rotation origin.
     # @param (see #draw)
@@ -960,6 +960,14 @@ module Gosu
     # @see Gosu.gamepad_name
     def gamepad_disconnected(index); end
 
+    ##
+    # Called when the window gains focus
+    def gain_focus; end
+
+    ##
+    # Called when the windows loses focus
+    def lose_focus; end
+
     # @!endgroup
   end
 

data/src/Bitmap.cpp

@@ -31,20 +31,20 @@ void Gosu::Bitmap::resize(int width, int height, Color c)
 
 void Gosu::Bitmap::blend_pixel(int x, int y, Color c)
 {
-    if (c.alpha() == 0) return;
+    if (c.alpha == 0) return;
 
     Color out = get_pixel(x, y);
-    if (out.alpha() == 0) {
+    if (out.alpha == 0) {
         set_pixel(x, y, c);
         return;
     }
 
-    int inv_alpha = out.alpha() * (255 - c.alpha()) / 255;
+    int inv_alpha = out.alpha * (255 - c.alpha) / 255;
 
-    out.set_alpha(c.alpha() + inv_alpha);
-    out.set_red  ((c.red()   * c.alpha() + out.red()   * inv_alpha) / out.alpha());
-    out.set_green((c.green() * c.alpha() + out.green() * inv_alpha) / out.alpha());
-    out.set_blue ((c.blue()  * c.alpha() + out.blue()  * inv_alpha) / out.alpha());
+    out.alpha = (c.alpha + inv_alpha);
+    out.red =   ((c.red   * c.alpha + out.red   * inv_alpha) / out.alpha);
+    out.green = ((c.green * c.alpha + out.green * inv_alpha) / out.alpha);
+    out.blue =  ((c.blue  * c.alpha + out.blue  * inv_alpha) / out.alpha);
 
     set_pixel(x, y, out);
 }
@@ -108,9 +108,9 @@ void Gosu::apply_color_key(Bitmap& bitmap, Color key)
                 auto visit = [&](Color c) {
                   if (c != key) {
                       neighbors += 1;
-                      red += c.red();
-                      green += c.green();
-                      blue += c.blue();
+                      red += c.red;
+                      green += c.green;
+                      blue += c.blue;
                   }
                 };
 
@@ -121,9 +121,9 @@ void Gosu::apply_color_key(Bitmap& bitmap, Color key)
 
                 Color replacement = Color::NONE;
                 if (neighbors > 0) {
-                    replacement.set_red(red / neighbors);
-                    replacement.set_green(green / neighbors);
-                    replacement.set_blue(blue / neighbors);
+                    replacement.red = red / neighbors;
+                    replacement.green = green / neighbors;
+                    replacement.blue = blue / neighbors;
                 }
                 bitmap.set_pixel(x, y, replacement);
             }