gosu 0.14.0.pre2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fae36fbf2c222327884fa9b34c5c2dc0a085a8fe7389dcc3c58d6d865b44a8f5
-  data.tar.gz: 843de673ab12f0d0ab72f29d560e29dd1262ecb8e4c1929118fc9dd770db5b77
+  metadata.gz: 74fc901e66738f4992205611236f6a7e71e5e3db59f91cda307c54a7b4f1c1d5
+  data.tar.gz: '08b48f76d3a3d55f5d192551abd7c8c41c6b1a5c8fce354261195a179f7f45c9'
 SHA512:
-  metadata.gz: 7a0f3a6bc482c1e30dbf2e04a4097ddde5fe630a8583875c9344463808d306b8f0c41131b70229bfc0f343e948d15714e65707bef077c18b434c434f9bd6a3e3
-  data.tar.gz: 2a1ec2451e8653b6dd7682faf8c4e7cf4b354a778234c0db51c4f0f17ad547a7a6356019c25d8458f1975d685c81f8e219cd384c2e81ed285f8053b5e2a61077
+  metadata.gz: eb408ee328e685dea6324d6bc8a954b180fd7b1bcb286df3897e7f3b734ba7225c7d05895d21cbfaa9cb168cd59e806a3a16599d9c770603727d9f9a20cb1a7d
+  data.tar.gz: d033a75590ece4317582ad74f6b2183e0ebe715df51d8993c5d2b3754499ca209bebe6bb31d5e3ec38d5a44fd8516e5bd09de50256cf11782243f353fef21871

data/Gosu/Bitmap.hpp

@@ -59,6 +59,10 @@ namespace Gosu
         {
             pixels[y * w + x] = c;
         }
+        
+        //! This updates a pixel using the "over" alpha compositing operator, see:
+        //! https://en.wikipedia.org/wiki/Alpha_compositing
+        void blend_pixel(unsigned x, unsigned y, Color c);
 
         //! Inserts a bitmap at the given position. Parts of the inserted
         //! bitmap that would be outside of the target bitmap will be

data/Gosu/Font.hpp

@@ -13,10 +13,8 @@
 
 namespace Gosu
 {
-    //! A font can be used to draw text on a Graphics object very flexibly.
-    //! Fonts are ideal for small texts that change regularly. For large,
-    //! static texts you should use create_bitmap and turn the result into
-    //! an image.
+    //! Fonts are ideal for drawing short, dynamic strings.
+    //! For large, static texts you should use Gosu::layout_text and turn the result into an image.
     class Font
     {
         struct Impl;
@@ -29,7 +27,7 @@ namespace Gosu
         //! \param font_height Height of the font, in pixels.
         //! \param font_flags Flags used to render individual characters of
         //!        the font.
-        Font(int height, const std::string& name = default_font_name(), unsigned flags = FF_BOLD);
+        Font(int height, const std::string& name = default_font_name(), unsigned flags = 0);
         
         //! Returns the name of the font that was used to create it.
         const std::string& name() const;
@@ -41,45 +39,42 @@ namespace Gosu
         unsigned flags() const;
         
         //! Returns the width, in pixels, the given text would occupy if drawn.
-        double text_width(const std::string& text, double scale_x = 1) const;
+        double text_width(const std::string& text) const;
+        //! Returns the width, in pixels, the given text would occupy if drawn.
+        double markup_width(const std::string& markup) const;
         
         //! Draws text so the top left corner of the text is at (x; y).
-        //! \param text Formatted text without line-breaks.
-        void draw(const std::string& text, double x, double y, ZPos z,
-                  double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
-                  AlphaMode mode = AM_DEFAULT) const;
+        void draw_text(const std::string& text, double x, double y, ZPos z,
+                       double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
+                       AlphaMode mode = AM_DEFAULT) const;
+        //! Draws markup so the top left corner of the text is at (x; y).
+        void draw_markup(const std::string& markup, double x, double y, ZPos z,
+                         double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
+                         AlphaMode mode = AM_DEFAULT) const;
         
         //! Draws text at a position relative to (x; y).
         //! \param rel_x Determines where the text is drawn horizontally. If
         //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
         //! the text will be to the left of x, if it is 0.5, it will be
-        //! centered on x. Of course, all real numbers are possible values.
+        //! centered on x. All real numbers are possible values.
         //! \param rel_y See rel_x.
-        void draw_rel(const std::string& text, double x, double y, ZPos z,
-                      double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
-                      Color c = Color::WHITE, AlphaMode mode = AM_DEFAULT) const;
-
-        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle.
-        //! Use Graphics::push_transform to achieve the same effect.
-    #ifndef SWIG
-        GOSU_DEPRECATED
-    #endif
-        void draw_rot(const std::string& text, double x, double y, ZPos z, double angle,
-                      double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
-                      AlphaMode mode = AM_DEFAULT) const;
-
-        //! Maps a letter to a specific image instead of generating one using
-        //! Gosu's built-in text rendering. This can only be called once per
-        //! character, and the character must not have been drawn before.
-        //! This ensures that Fonts are still (sort of) immutable.
-    #ifndef SWIG
-        GOSU_DEPRECATED
-    #endif
+        void draw_text_rel(const std::string& text, double x, double y, ZPos z,
+                           double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
+                           Color c = Color::WHITE, AlphaMode mode = AM_DEFAULT) const;
+        //! Draws text at a position relative to (x; y).
+        //! \param rel_x Determines where the text is drawn horizontally. If
+        //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
+        //! the text will be to the left of x, if it is 0.5, it will be
+        //! centered on x. All real numbers are possible values.
+        //! \param rel_y See rel_x.
+        void draw_markup_rel(const std::string& markup, double x, double y, ZPos z,
+                             double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
+                             Color c = Color::WHITE, AlphaMode mode = AM_DEFAULT) const;
+        
+        //! Maps a letter to a specific image, instead of generating one using
+        //! Gosu's built-in text rendering.
         void set_image(std::string codepoint, unsigned font_flags, const Gosu::Image& image);
         //! A shortcut for mapping a character to an image regardless of font_flags.
-    #ifndef SWIG
-        GOSU_DEPRECATED
-    #endif
         void set_image(std::string codepoint, const Gosu::Image& image);
     };
 }

data/Gosu/Text.hpp

@@ -20,8 +20,8 @@ namespace Gosu
     double text_width(const std::u32string& text, const std::string& font_name, double font_height,
                       unsigned font_flags = 0);
 
-    //! Draws a line of unformatted text on a bitmap. This is a very low-level function that does
-    //! not understand any of Gosu's HTML-like markup.
+    //! Draws a line of unformatted 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.
@@ -29,15 +29,23 @@ namespace Gosu
     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 a line of formatted text given to the function.
+    //! 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 text 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 create_text(const std::string& text, const std::string& font_name, double font_height,
-                       unsigned font_flags = 0);
-
+    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 text Formatted text.
@@ -48,7 +56,10 @@ namespace Gosu
     //! \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 create_text(const std::string& text, const std::string& font_name, double font_height,
-                       double line_spacing, int width, Alignment align, unsigned font_flags = 0);
+    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/Gosu/Utility.hpp

@@ -7,11 +7,6 @@
 
 namespace Gosu
 {
-    //! Converts an UTF-8 to UCS-4 or UTF-16, depending on the platform's interpretation of wstring.
-    std::wstring utf8_to_wstring(const std::string& utf8);
-    //! Converts an UCS-4 or UTF-16 to UTF-8, depending on the platform's interpretation of wstring.
-    std::string wstring_to_utf8(const std::wstring& ws);
-    
     std::u32string utf8_to_composed_utc4(const std::string& utf8);
     
     //! Returns true if the filename has the given extension.

data/Gosu/Version.hpp

@@ -3,8 +3,8 @@
 #include <string>
 
 #define GOSU_MAJOR_VERSION 0
-#define GOSU_MINOR_VERSION 13
-#define GOSU_POINT_VERSION 3
+#define GOSU_MINOR_VERSION 14
+#define GOSU_POINT_VERSION 0
 
 namespace Gosu
 {

data/Gosu/Window.hpp

@@ -18,27 +18,12 @@
 
 namespace Gosu
 {
-    //! Returns the width (in pixels) of the user's primary screen.
-    unsigned screen_width();
-    
-    //! Returns the height (in pixels) of the user's primary screen.
-    unsigned screen_height();
-    
-    //! Returns the maximum width (in 'points') that is available for a non-fullscreen Window.
-    //! All windows larger than this size will automatically be shrunk to fit.
-    unsigned available_width();
-    
-    //! Returns the maximum height (in 'points') that is available for a non-fullscreen Window.
-    //! All windows larger than this size will automatically be shrunk to fit.
-    unsigned available_height();
-    
     //! Convenient all-in-one class that serves as the foundation of a standard Gosu application.
     //! Manages initialization of all of Gosu's core components and provides timing functionality.
     //! Note that you should really only use one instance of this class at the same time.
     class Window
     {
         struct Impl;
-        // Non-movable (const) to avoid dangling internal references.
         const std::unique_ptr<Impl> pimpl;
 
     public:
@@ -68,7 +53,7 @@ namespace Gosu
         virtual void show();
         
         //! EXPERIMENTAL - MAY DISAPPEAR WITHOUT WARNING.
-        //! Performs a single mainloop step.
+        //! Performs a single main loop step.
         //! This method is only useful if you want to integrate Gosu with another library that has
         //! its own main loop.
         //! This method implicitly shows the window if it was hidden before, and returns false when
@@ -141,4 +126,26 @@ namespace Gosu
         void* uikit_window() const;
         #endif
     };
+
+    //! Returns the width (in pixels) of a screen.
+    //! \param window The result describes the screen on which the window is shown, or the
+    //!               primary screen if no window is given.
+    unsigned screen_width(Window* window = nullptr);
+    
+    //! Returns the height (in pixels) of the user's primary screen.
+    //! \param window The result describes the screen on which the window is shown, or the
+    //!               primary screen if no window is given.
+    unsigned screen_height(Window* window = nullptr);
+    
+    //! Returns the maximum width (in 'points') that is available for a non-fullscreen Window.
+    //! All windows larger than this size will automatically be shrunk to fit.
+    //! \param window The result describes the screen on which the window is shown, or the
+    //!               primary screen if no window is given.
+    unsigned available_width(Window* window = nullptr);
+    
+    //! Returns the maximum height (in 'points') that is available for a non-fullscreen Window.
+    //! All windows larger than this size will automatically be shrunk to fit.
+    //! \param window The result describes the screen on which the window is shown, or the
+    //!               primary screen if no window is given.
+    unsigned available_height(Window* window = nullptr);
 }

data/lib/gosu/compat.rb

@@ -129,7 +129,21 @@ class Gosu::Song
   end
 end
 
-# Moved some Window-methods to the Gosu::Module
+class Gosu::Font
+  alias_method :draw, :draw_markup
+  Gosu.deprecate Gosu::Font, :draw, "Font#draw_text or Font#draw_markup"
+  
+  alias_method :draw_rel, :draw_markup_rel
+  Gosu.deprecate Gosu::Font, :draw_rel, "Font#draw_text_rel or Font#draw_markup_rel"
+
+  def draw_rot(markup, x, y, z, angle, scale_x = 1, scale_y = 1, c = 0xff_ffffff, mode = :default)
+    Gosu.rotate(angle, x, y) { draw_markup(markup, x, y, z, scale_x, scale_y, c, mode) }
+  end
+
+  Gosu.deprecate Gosu::Font, :draw_rot, "Font#draw with Gosu.rotate"
+end
+
+# Moved some Window methods to the Gosu module.
 class Gosu::Window
   # Class methods that have been turned into module methods.
   class << self
@@ -151,13 +165,12 @@ class Gosu::Window
       Gosu.send method, *args, &block
     end
   end
+
+  Gosu.deprecate Gosu::Window, :set_mouse_position, "Window#mouse_x= and Window#mouse_y="
 end
 
 # Constants
 module Gosu
-  Gosu.deprecate Window, :set_mouse_position, "Window#mouse_x= and Window#mouse_y="
-  Gosu.deprecate Font, :draw_rot, "Font#draw with Gosu.rotate"
-  
   # This was renamed because it's not actually a "copyright notice".
   # (https://en.wikipedia.org/wiki/Copyright_notice)
   deprecate_const :GOSU_COPYRIGHT_NOTICE, :LICENSES

data/lib/gosu/patches.rb

@@ -18,6 +18,22 @@ class ::Numeric
   end
 end
 
+class Gosu::Font
+  # draw_text will stop parsing markup in Gosu 1.0.
+  alias_method :draw_text, :draw_markup
+  # draw_text_rel will stop parsing markup in Gosu 1.0.
+  alias_method :draw_text_rel, :draw_markup_rel
+  # text_width will stop parsing markup in Gosu 1.0.
+  alias_method :text_width, :markup_width
+end
+
+class Gosu::Image
+  # from_markup will stop parsing markup in Gosu 1.0.
+  def self.from_markup(*args)
+    self.from_text(*args)
+  end
+end
+
 # Color constants.
 # This is cleaner than having SWIG define them.
 module Gosu

data/rdoc/gosu.rb

@@ -233,7 +233,10 @@ module Gosu
     #
     # @param height [Integer] the height of the font, in pixels.
     # @param [Hash] options
-    # @option options [String] :name the name of a system font, or a path to a TrueType Font (TTF) file. A path must contain at least one '/' character to distinguish it from a system font.
+    # @option options [String] :name the name of a system font, or a path to a TrueType Font (TTF) file. A path must contain at least one '/' or '.' character to distinguish it from a system font.
+    # @option options [bool] :bold (false)
+    # @option options [bool] :italic (false)
+    # @option options [bool] :underline (false)
     #
     # @overload initialize(height, options = {})
     # @overload initialize(window, font_name, height)
@@ -268,7 +271,11 @@ module Gosu
     # @see Gosu::Image.from_text
     # @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(text, x, y, z, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+    def draw_text(text, x, y, z, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+
+    ##
+    # Like {#draw_text}, but supports the following markup tags: `<b>bold</b>`, `<i>italic</i>`, `<c=rrggbb>colors</c>`.
+    def draw_markup(markup, x, y, z, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
 
     ##
     # Draws a single line of text relative to (x, y).
@@ -285,7 +292,11 @@ 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_rel(text, x, y, z, rel_x, rel_y, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+    def draw_text_rel(text, x, y, z, rel_x, rel_y, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
+
+    ##
+    # Like {#draw_text_rel}, but supports the following markup tags: `<b>bold</b>`, `<i>italic</i>`, `<c=rrggbb>colors</c>`.
+    def draw_markup_rel(markup, x, y, z, rel_x, rel_y, scale_x=1, scale_y=1, color=0xff_ffffff, mode=:default); end
 
     # @!endgroup
 
@@ -295,6 +306,10 @@ 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
   end
 
   ##
@@ -348,6 +363,9 @@ module Gosu
     # @param [Integer] line_height the line height, in pixels.
     # @param [Hash] options
     # @option options [String] :font (Gosu::default_font_name) the name of a system font, or a path to a TrueType Font (TTF) file. A path must contain at least one '/' character to distinguish it from a system font.
+    # @option options [bool] :bold (false)
+    # @option options [bool] :italic (false)
+    # @option options [bool] :underline (false)
     # @option options [Integer] :width the width of the image, in pixels. Long lines will be automatically wrapped around to avoid overflow, but overlong words will be truncated. If this option is omitted, lines will not be wrapped, and :align and :spacing will be ignored as well.
     # @option options [Integer] :spacing (0) the spacing between lines, in pixels.
     # @option options [:left, :right, :center, :justify] :align (:left) the text alignment.
@@ -357,6 +375,10 @@ module Gosu
     # @see https://github.com/gosu/gosu/wiki/Basic-Concepts#drawing-with-colours Drawing with colors, explained in the Gosu Wiki
     def self.from_text(text, line_height, options = {}); end
 
+    ##
+    # Like {#from_text}, but supports the following markup tags: `<b>bold</b>`, `<i>italic</i>`, `<c=rrggbb>colors</c>`.
+    def self.from_markup(markup, line_height, options = {}); end
+
     ##
     # Loads an image from a file or an RMagick image, then divides the image into an array of equal-sized tiles.
     #
@@ -1223,20 +1245,22 @@ module Gosu
     def default_font_name(); end
 
     ##
-    # @return [Integer] the width (in pixels) of the user's primary screen.
-    def screen_width(); end
+    # @return [Integer] the width (in pixels) of a screen.
+    # @param window [Gosu::Window] The result describes the screen on which the window is shown, or the primary screen if no window is given.
+    def screen_width(window = nil); end
 
-    # @return [Integer] the height (in pixels) of the user's primary screen.
-    def screen_height(); end
+    # @return [Integer] the height (in pixels) of a screen.
+    # @param window [Gosu::Window] The result describes the screen on which the window is shown, or the primary screen if no window is given.
+    def screen_height(window = nil); end
 
     ##
     # @return [Integer] the maximum width (in 'points') that is available for a non-fullscreen Window.
     # All windows larger than this size will automatically be shrunk to fit.
-    def available_width(); end
+    def available_width(window = nil); end
 
     # @return [Integer] the maximum height (in 'points') that is available for a non-fullscreen Window.
     # All windows larger than this size will automatically be shrunk to fit.
-    def available_height(); end
+    def available_height(window = nil); end
 
     ##
     # Returns the language code for the user's preferred language.

data/src/Bitmap.cpp

@@ -19,6 +19,26 @@ void Gosu::Bitmap::resize(unsigned width, unsigned height, Color c)
     temp.insert(*this, 0, 0);
     swap(temp);
 }
+
+void Gosu::Bitmap::blend_pixel(unsigned x, unsigned y, Color c)
+{
+    if (c.alpha() == 0) return;
+    
+    Color out = get_pixel(x, y);
+    if (out.alpha() == 0) {
+        set_pixel(x, y, c);
+        return;
+    }
+    
+    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());
+    
+    set_pixel(x, y, out);
+}
 
 void Gosu::Bitmap::insert(const Bitmap& source, int x, int y)
 {

data/src/DirectoriesWin.cpp

@@ -20,7 +20,7 @@ static string special_folder_path(int csidl)
         buf[len] = L'\\';
         buf[len + 1] = 0;
     }
-    return Gosu::wstring_to_utf8(buf);
+    return Gosu::utf16_to_utf8(buf);
 }
 
 static string exe_filename()
@@ -30,14 +30,14 @@ static string exe_filename()
         WCHAR buffer[MAX_PATH * 2];
         Gosu::winapi_check(GetModuleFileNameW(nullptr, buffer, MAX_PATH * 2),
                            "getting the module filename");
-        result = Gosu::wstring_to_utf8(buffer);
+        result = Gosu::utf16_to_utf8(buffer);
     }
     return result;
 }
 
 void Gosu::use_resource_directory()
 {
-    SetCurrentDirectory(utf8_to_wstring(resource_prefix()).c_str());
+    SetCurrentDirectory(utf8_to_utf16(resource_prefix()).c_str());
 }
 
 string Gosu::resource_prefix()