gosu 1.4.1 → 1.4.3

data/include/Gosu/Buttons.hpp

@@ -7,111 +7,111 @@ namespace Gosu
     /// mouse buttons and mouse wheel (MS_*), as well as gamepad buttons (GP_*).
     enum Button
     {
-        KB_ESCAPE          = 41,
-        KB_F1              = 58,
-        KB_F2              = 59,
-        KB_F3              = 60,
-        KB_F4              = 61,
-        KB_F5              = 62,
-        KB_F6              = 63,
-        KB_F7              = 64,
-        KB_F8              = 65,
-        KB_F9              = 66,
-        KB_F10             = 67,
-        KB_F11             = 68,
-        KB_F12             = 69,
-        KB_0               = 39,
-        KB_1               = 30,
-        KB_2               = 31,
-        KB_3               = 32,
-        KB_4               = 33,
-        KB_5               = 34,
-        KB_6               = 35,
-        KB_7               = 36,
-        KB_8               = 37,
-        KB_9               = 38,
-        KB_TAB             = 43,
-        KB_RETURN          = 40,
-        KB_SPACE           = 44,
-        KB_LEFT_SHIFT      = 225,
-        KB_RIGHT_SHIFT     = 229,
-        KB_LEFT_CONTROL    = 224,
-        KB_RIGHT_CONTROL   = 228,
-        KB_LEFT_ALT        = 226,
-        KB_RIGHT_ALT       = 230,
-        KB_LEFT_META       = 227,
-        KB_RIGHT_META      = 231,
-        KB_BACKSPACE       = 42,
-        KB_LEFT            = 80,
-        KB_RIGHT           = 79,
-        KB_UP              = 82,
-        KB_DOWN            = 81,
-        KB_HOME            = 74,
-        KB_END             = 77,
-        KB_PRINT_SCREEN    = 70,
-        KB_SCROLL_LOCK     = 71,
-        KB_PAUSE           = 72,
-        KB_INSERT          = 73,
-        KB_DELETE          = 76,
-        KB_PAGE_UP         = 75,
-        KB_PAGE_DOWN       = 78,
-        KB_ENTER           = 88,
-        KB_BACKTICK        = 53,
-        KB_MINUS           = 45,
-        KB_EQUALS          = 46,
-        KB_LEFT_BRACKET    = 47,
-        KB_RIGHT_BRACKET   = 48,
-        KB_BACKSLASH       = 49,
-        KB_SEMICOLON       = 51,
-        KB_APOSTROPHE      = 52,
-        KB_COMMA           = 54,
-        KB_PERIOD          = 55,
-        KB_SLASH           = 56,
-        KB_CAPS_LOCK       = 57,
-        KB_A               = 4,
-        KB_B               = 5,
-        KB_C               = 6,
-        KB_D               = 7,
-        KB_E               = 8,
-        KB_F               = 9,
-        KB_G               = 10,
-        KB_H               = 11,
-        KB_I               = 12,
-        KB_J               = 13,
-        KB_K               = 14,
-        KB_L               = 15,
-        KB_M               = 16,
-        KB_N               = 17,
-        KB_O               = 18,
-        KB_P               = 19,
-        KB_Q               = 20,
-        KB_R               = 21,
-        KB_S               = 22,
-        KB_T               = 23,
-        KB_U               = 24,
-        KB_V               = 25,
-        KB_W               = 26,
-        KB_X               = 27,
-        KB_Y               = 28,
-        KB_Z               = 29,
+        KB_ESCAPE = 41,
+        KB_F1 = 58,
+        KB_F2 = 59,
+        KB_F3 = 60,
+        KB_F4 = 61,
+        KB_F5 = 62,
+        KB_F6 = 63,
+        KB_F7 = 64,
+        KB_F8 = 65,
+        KB_F9 = 66,
+        KB_F10 = 67,
+        KB_F11 = 68,
+        KB_F12 = 69,
+        KB_0 = 39,
+        KB_1 = 30,
+        KB_2 = 31,
+        KB_3 = 32,
+        KB_4 = 33,
+        KB_5 = 34,
+        KB_6 = 35,
+        KB_7 = 36,
+        KB_8 = 37,
+        KB_9 = 38,
+        KB_TAB = 43,
+        KB_RETURN = 40,
+        KB_SPACE = 44,
+        KB_LEFT_SHIFT = 225,
+        KB_RIGHT_SHIFT = 229,
+        KB_LEFT_CONTROL = 224,
+        KB_RIGHT_CONTROL = 228,
+        KB_LEFT_ALT = 226,
+        KB_RIGHT_ALT = 230,
+        KB_LEFT_META = 227,
+        KB_RIGHT_META = 231,
+        KB_BACKSPACE = 42,
+        KB_LEFT = 80,
+        KB_RIGHT = 79,
+        KB_UP = 82,
+        KB_DOWN = 81,
+        KB_HOME = 74,
+        KB_END = 77,
+        KB_PRINT_SCREEN = 70,
+        KB_SCROLL_LOCK = 71,
+        KB_PAUSE = 72,
+        KB_INSERT = 73,
+        KB_DELETE = 76,
+        KB_PAGE_UP = 75,
+        KB_PAGE_DOWN = 78,
+        KB_ENTER = 88,
+        KB_BACKTICK = 53,
+        KB_MINUS = 45,
+        KB_EQUALS = 46,
+        KB_LEFT_BRACKET = 47,
+        KB_RIGHT_BRACKET = 48,
+        KB_BACKSLASH = 49,
+        KB_SEMICOLON = 51,
+        KB_APOSTROPHE = 52,
+        KB_COMMA = 54,
+        KB_PERIOD = 55,
+        KB_SLASH = 56,
+        KB_CAPS_LOCK = 57,
+        KB_A = 4,
+        KB_B = 5,
+        KB_C = 6,
+        KB_D = 7,
+        KB_E = 8,
+        KB_F = 9,
+        KB_G = 10,
+        KB_H = 11,
+        KB_I = 12,
+        KB_J = 13,
+        KB_K = 14,
+        KB_L = 15,
+        KB_M = 16,
+        KB_N = 17,
+        KB_O = 18,
+        KB_P = 19,
+        KB_Q = 20,
+        KB_R = 21,
+        KB_S = 22,
+        KB_T = 23,
+        KB_U = 24,
+        KB_V = 25,
+        KB_W = 26,
+        KB_X = 27,
+        KB_Y = 28,
+        KB_Z = 29,
         /// ` on US/UK macOS, < on EU macOS, \ on US/UK Windows
-        KB_ISO             = 100,
-        KB_NUMPAD_0        = 98,
-        KB_NUMPAD_1        = 89,
-        KB_NUMPAD_2        = 90,
-        KB_NUMPAD_3        = 91,
-        KB_NUMPAD_4        = 92,
-        KB_NUMPAD_5        = 93,
-        KB_NUMPAD_6        = 94,
-        KB_NUMPAD_7        = 95,
-        KB_NUMPAD_8        = 96,
-        KB_NUMPAD_9        = 97,
-        KB_NUMPAD_DELETE   = 99,
-        KB_NUMPAD_PLUS     = 87,
-        KB_NUMPAD_MINUS    = 86,
+        KB_ISO = 100,
+        KB_NUMPAD_0 = 98,
+        KB_NUMPAD_1 = 89,
+        KB_NUMPAD_2 = 90,
+        KB_NUMPAD_3 = 91,
+        KB_NUMPAD_4 = 92,
+        KB_NUMPAD_5 = 93,
+        KB_NUMPAD_6 = 94,
+        KB_NUMPAD_7 = 95,
+        KB_NUMPAD_8 = 96,
+        KB_NUMPAD_9 = 97,
+        KB_NUMPAD_DELETE = 99,
+        KB_NUMPAD_PLUS = 87,
+        KB_NUMPAD_MINUS = 86,
         KB_NUMPAD_MULTIPLY = 85,
-        KB_NUMPAD_DIVIDE   = 84,
-        KB_RANGE_END       = 0xff,
+        KB_NUMPAD_DIVIDE = 84,
+        KB_RANGE_END = 0xff,
 
         MS_RANGE_BEGIN,
         MS_LEFT = MS_RANGE_BEGIN,

data/include/Gosu/Directories.hpp

@@ -1,36 +1,43 @@
-//! \file Directories.hpp
-//! Access to a small set of system paths.
-
 #pragma once
 
 #include <string>
 
 namespace Gosu
 {
-    //! Changes the current directory to the result of resource_prefix().
+    /// Changes the current directory to the result of resource_prefix().
     void use_resource_directory();
     
-    //! Prefix for a program's own resources.
-    //! On Windows, the parent directory of the executable.
-    //! On macOS, the 'Resources' directory inside the .app bundle.
-    //! On Linux, the current directory (empty string).
-    std::string resource_prefix();
+    /// Prefix for a program's own resources.
+    /// <ul>
+    /// <li> Windows: The parent directory of the executable.
+    /// <li> macOS, iOS: The 'Resources' directory inside the .app bundle.
+    /// <li> Linux: The current directory (empty string).
+    /// </ul>
+    const std::string& resource_prefix();
     
-    //! Prefix for shared resources of a group of programs.
-    //! On Windows, the parent directory of the executable.
-    //! On macOS, the parent directory of the .app bundle.
-    //! On Linux, the current directory (empty string).
-    std::string shared_resource_prefix();
+    /// Prefix for shared resources of a group of programs, e.g. the game and its level editor.
+    /// <ul>
+    /// <li> Windows: The parent directory of the executable.
+    /// <li> macOS: The parent directory of the .app bundle.
+    /// <li> Linux: The current directory (empty string).
+    /// </uil>
+    const std::string& shared_resource_prefix();
     
-    //! Prefix for user settings.
-    //! On Windows, the same as %APPDATA%.
-    //! On macOS, the user's Library/Preferences folder.
-    //! On Linux, the home directory plus a trailing dot for hidden files.
-    std::string user_settings_prefix();
+    /// Prefix for user settings.
+    /// <ul>
+    /// <li> Windows: The same as %APPDATA%.
+    /// <li> macOS: The user's Library/Preferences folder.
+    /// <li> Linux: The home directory plus a trailing dot for hidden files.
+    /// </ul>
+    const std::string& user_settings_prefix();
     
-    //! Prefix for user documents, e.g. saved games.
-    //! On Windows, the My Documents folder.
-    //! On macOS, the user's Documents folder.
-    //! On Linux, the home directory.
-    std::string user_documents_prefix();
+    /// Prefix for user documents, e.g. saved games.
+    /// <ul>
+    /// <li> Windows: The "My Documents" folder.
+    /// <li> macOS: The user's "Documents" folder.
+    /// <li> Linux: The home directory.
+    /// </ul>
+    const std::string& user_documents_prefix();
+
+    // TODO: Instead of re-inventing wheels here, we should wrap SDL_GetBasePath / SDL_GetPrefPath.
 }

data/include/Gosu/Font.hpp

@@ -20,9 +20,10 @@ namespace Gosu
     public:
         /// @param name   Name of a system font, or path to a TTF file (must contain '/').
         /// @param height Height of the font, in pixels.
-        /// @param flags  Flags used to render individual characters of the font (FontFlags enum).
+        /// @param font_flags  Flags used to render individual characters of the font (FontFlags enum).
+        /// @param image_flags  Flags used to render individual characters of the font (ImageFlags enum).
         explicit Font(int height, const std::string& name = default_font_name(),
-                      unsigned flags = 0);
+                      unsigned font_flags = 0, unsigned image_flags = 0);
 
         /// Returns the name of the font that was used to create it, i.e. the filename, nor the
         /// internal TTF name. (TODO: Why not?)
@@ -33,6 +34,7 @@ namespace Gosu
 
         /// Returns the flags used to render the characters of the font (FontFlags enum).
         unsigned flags() const;
+        unsigned image_flags() const;
 
         /// Returns the width, in pixels, that the given text would occupy if drawn.
         double text_width(const std::string& text) const;

data/include/Gosu/Gosu.hpp

@@ -1,11 +1,8 @@
-//! \file Gosu.hpp
-//! Umbrella header for all of Gosu.
-
-//! \mainpage Gosu C++ Documentation
-//!
-//! These pages serve as a reference on the C++ interface of Gosu. For a higher-level
-//! discussion of concepts and ideas behind the library, see the Wiki entries linked
-//! from the official website, https://www.libgosu.org/.
+/// \mainpage Gosu C++ Documentation
+///
+/// These pages serve as a reference on the C++ interface of Gosu. For a higher-level
+/// discussion of concepts and ideas behind the library, see the Wiki entries linked
+/// from the official website, https://www.libgosu.org/.
 
 #pragma once
 

data/include/Gosu/IO.hpp

@@ -1,6 +1,3 @@
-//! \file IO.hpp
-//! Contains everything related to input and output.
-
 #pragma once
 
 #include <Gosu/Platform.hpp>

data/include/Gosu/Math.hpp

@@ -1,6 +1,3 @@
-//! \file Math.hpp
-//! Contains simple math functionality.
-
 #pragma once
 
 #include <cmath>

data/include/Gosu/Timing.hpp

@@ -1,14 +1,8 @@
-//! \file Timing.hpp
-//! Functions for timing.
-
 #pragma once
 
 namespace Gosu
 {
-    //! Freezes the current thread for at least the specified time.
-    void sleep(unsigned milliseconds);
-
-    //! Returns the milliseconds since first calling this function.
-    //! Can wrap after running for a long time.
+    /// Returns the milliseconds since first calling this function.
+    /// Can wrap after running for a long time.
     unsigned long milliseconds();
 }

data/include/Gosu/Version.hpp

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

data/src/AudioImpl.cpp

@@ -33,13 +33,6 @@ bool Gosu::al_initialized()
     return _device != nullptr;
 }
 
-ALCdevice* Gosu::al_device()
-{
-    al_initialize();
-    
-    return _device;
-}
-
 ALCcontext* Gosu::al_context()
 {
     al_initialize();

data/src/AudioImpl.hpp

@@ -3,7 +3,7 @@
 #include <Gosu/Audio.hpp>
 #include <Gosu/Platform.hpp>
 #ifdef GOSU_IS_IPHONE
-// Ignore OpenAL deprecation warnings. If macOS stops shipping OpenAL, it's more likely that we bundle our own version
+// Ignore OpenAL deprecation warnings. If iOS stops shipping OpenAL, it's more likely that we bundle our own version
 // of it than that we switch to another audio API.
 #define OPENAL_DEPRECATED
 #include <OpenAL/al.h>
@@ -18,8 +18,6 @@ namespace Gosu
     void al_initialize();
     bool al_initialized();
 
-    // Will initialize OpenAL if necessary.
-    ALCdevice* al_device();
     // Will initialize OpenAL if necessary.
     ALCcontext* al_context();
 

data/src/BitmapIO.cpp

@@ -39,6 +39,26 @@ static bool is_bmp(Gosu::Reader reader)
     return magic_bytes[0] == 'B' && magic_bytes[1] == 'M';
 }
 
+/// Returns a copy of the given Gosu::Image with the alpha channel removed.
+/// Every pixel with alpha==0 will be replaced by Gosu::Color::FUCHSIA.
+static std::vector<Gosu::Color::Channel> bitmap_to_rgb(const Gosu::Bitmap& bmp)
+{
+    std::vector<Gosu::Color::Channel> rgb(static_cast<std::size_t>(bmp.width() * bmp.height() * 3));
+    for (std::size_t offset = 0; offset < rgb.size(); offset += 3) {
+        const Gosu::Color& color = bmp.data()[offset / 3];
+        if (color.alpha == 0) {
+            rgb[offset + 0] = 0xff;
+            rgb[offset + 1] = 0x00;
+            rgb[offset + 2] = 0xff;
+        } else {
+            rgb[offset + 0] = color.red;
+            rgb[offset + 1] = color.green;
+            rgb[offset + 2] = color.blue;
+        }
+    }
+    return rgb;
+}
+
 Gosu::Bitmap Gosu::load_image_file(const std::string& filename)
 {
     Buffer buffer;
@@ -80,7 +100,8 @@ void Gosu::save_image_file(const Gosu::Bitmap& bitmap, const std::string& filena
     int ok;
 
     if (has_extension(filename, "bmp")) {
-        ok = stbi_write_bmp(filename.c_str(), bitmap.width(), bitmap.height(), 4, bitmap.data());
+        ok = stbi_write_bmp(filename.c_str(), bitmap.width(), bitmap.height(), 3,
+                            bitmap_to_rgb(bitmap).data());
     }
     else if (has_extension(filename, "tga")) {
         ok = stbi_write_tga(filename.c_str(), bitmap.width(), bitmap.height(), 4, bitmap.data());
@@ -106,7 +127,7 @@ void Gosu::save_image_file(const Gosu::Bitmap& bitmap, Gosu::Writer writer,
 
     if (has_extension(format_hint, "bmp")) {
         ok = stbi_write_bmp_to_func(stbi_write_to_writer, &writer, bitmap.width(), bitmap.height(),
-                                    4, bitmap.data());
+                                    3, bitmap_to_rgb(bitmap).data());
     }
     else if (has_extension(format_hint, "tga")) {
         stbi_write_tga_with_rle = 0;

data/src/DirectoriesApple.cpp

@@ -4,65 +4,66 @@
 #import <Gosu/Directories.hpp>
 #import <Foundation/Foundation.h>
 #import <unistd.h>
-using namespace std;
 
 void Gosu::use_resource_directory()
 {
     chdir(resource_prefix().c_str());
 }
 
-string Gosu::user_settings_prefix()
+const std::string& Gosu::user_settings_prefix()
 {
-    static string result = [] {
+    static const std::string user_settings_prefix = [] {
         @autoreleasepool {
             NSString* library =
-                NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES)[0];
+                    NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES)
+                            .firstObject;
             NSString* preferences = [library stringByAppendingPathComponent:@"Preferences"];
-            
-            return string(preferences.UTF8String ?: ".") + "/";
+
+            return std::string{preferences.UTF8String ?: "."} + "/";
         }
     }();
-    return result;
+    return user_settings_prefix;
 }
 
-string Gosu::user_documents_prefix()
+const std::string& Gosu::user_documents_prefix()
 {
-    static string result = [] {
+    static const std::string user_documents_prefix = [] {
         @autoreleasepool {
             NSString* documents =
-                NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)[0];
-            
-            return string(documents.UTF8String ?: ".") + "/";
+                    NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)
+                            .firstObject;
+
+            return std::string{documents.UTF8String ?: "."} + "/";
         }
     }();
-    return result;
+    return user_documents_prefix;
 }
 
-string Gosu::resource_prefix()
+const std::string& Gosu::resource_prefix()
 {
-    static string result = [] {
+    static const std::string resource_prefix = [] {
         @autoreleasepool {
             NSString* resources = [NSBundle mainBundle].resourcePath;
-            return string(resources.UTF8String ?: ".") + "/";
+            return std::string{resources.UTF8String ?: "."} + "/";
         }
     }();
-    return result;
+    return resource_prefix;
 }
 
-string Gosu::shared_resource_prefix()
+const std::string& Gosu::shared_resource_prefix()
 {
-    #ifdef GOSU_IS_IPHONE
+#ifdef GOSU_IS_IPHONE
     return resource_prefix();
-    #else
-    static string result = [] {
+#else
+    static const std::string shared_resource_prefix = [] {
         @autoreleasepool {
             NSString* bundle_path = [NSBundle mainBundle].bundlePath;
             NSString* containing_path = [bundle_path stringByDeletingLastPathComponent];
-            return string(containing_path.UTF8String ?: ".");
+            return std::string{containing_path.UTF8String ?: "."};
         }
     }();
-    return result;
-    #endif
+    return shared_resource_prefix;
+#endif
 }
 
 #endif

data/src/DirectoriesUnix.cpp

@@ -7,13 +7,11 @@
 #include <pwd.h>
 #include <sys/types.h>
 #include <unistd.h>
-using namespace std;
 
-static string home_dir()
+static std::string home_dir()
 {
     passwd* pwd = getpwuid(geteuid());
-    assert (pwd && pwd->pw_dir);
-    return pwd->pw_dir;
+    return pwd && pwd->pw_dir ? pwd->pw_dir : ".";
 }
 
 void Gosu::use_resource_directory()
@@ -21,24 +19,28 @@ void Gosu::use_resource_directory()
     // Do nothing, we expect the user to have the correct cwd on Linux.
 }
 
-string Gosu::resource_prefix()
+const std::string& Gosu::resource_prefix()
 {
-    return string();
+    static const std::string empty;
+    return empty;
 }
 
-string Gosu::shared_resource_prefix()
+const std::string& Gosu::shared_resource_prefix()
 {
-    return string();
+    static const std::string empty;
+    return empty;
 }
 
-string Gosu::user_settings_prefix()
+const std::string& Gosu::user_settings_prefix()
 {
-    return home_dir() + "/.";
+    static const std::string user_settings_prefix = home_dir() + "/.";
+    return user_settings_prefix;
 }
 
-string Gosu::user_documents_prefix()
+const std::string& Gosu::user_documents_prefix()
 {
-    return home_dir() + "/";
+    static const std::string user_documents_prefix = home_dir() + "/";
+    return user_documents_prefix;
 }
 
 #endif