gosu 0.8.7.2 → 0.9.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 564e517e2fe465b35b11306eba8721dc1d98bb51
-  data.tar.gz: 48af31272649efe1e319f2d396ad52b9877849f9
+  metadata.gz: dd11308d7e4ec0b716285c993461a7eb3d0f4069
+  data.tar.gz: 72ae78ce681cbf45756c97d6267acca346bd08a9
 SHA512:
-  metadata.gz: 13f4c5098555aaa675e30988431440ede46aede40c4500aad8a8ecd1e7beba5175b4d62420279e1ace487c6d7575ed1c620c2d29c41793a6c346865f16fa5bb7
-  data.tar.gz: 8b28e1456134753e7b66dbbe023cd0f658a3ed5b28fb0df991f2b40ab62ebcb13a15c31ee9b7fd4f6774ff0a55bf37935a995aee3d94932eae236e1b5962f5f9
+  metadata.gz: f4c3400c2284f15cf12b9f036232c1790c77b63e76b6dfe19559b6fc2445ae57468fad1d5fdedd1d1c8a35ed39a16c4d7c10917498d2d5f6442da49890fc1bbb
+  data.tar.gz: 2a013ba899728594d5fabb8243c766c11eb08ae603485c435be051b1f6e3977a3287713b6ee9f852aa81a4febf5f40c7dd69bcc02e2e3b1c3a6fd4d91baa6787

data/COPYING

@@ -0,0 +1,29 @@
+Copyright (C) 2001-2015 Julian Raschke, Jan Lücker and all contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+            Julian Raschke <julian@raschke.de> & contributors
+                        http://www.libgosu.org/
+
+                                  ***
+
+This does NOT apply to libogg and libvorbis, which are included in all source
+and binary distributions of Gosu. These projects are licensed under a BSD-like
+license, and their copyright terms need to be supplied even with binary
+redistributions (e.g. Gosu games).

data/Gosu/Audio.hpp

@@ -36,6 +36,7 @@ namespace Gosu
 
 	public:
         //! Called by Sample, do not use.
+        // TODO: See if we can use 'friend' here.
 		SampleInstance(int handle, int extra);
 
 		bool playing() const;

data/Gosu/Font.hpp

@@ -8,6 +8,7 @@
 #include <Gosu/Color.hpp>
 #include <Gosu/GraphicsBase.hpp>
 #include <Gosu/Platform.hpp>
+#include <Gosu/Text.hpp>
 #include <Gosu/TR1.hpp>
 #include <string>
 
@@ -29,8 +30,8 @@ namespace Gosu
         //! \param fontHeight Height of the font, in pixels.
         //! \param fontFlags Flags used to render individual characters of
         //!        the font.
-        Font(Graphics& graphics, const std::wstring& fontName,
-            unsigned fontHeight, unsigned fontFlags = ffBold);
+        Font(unsigned fontHeight, const std::wstring& fontName = defaultFontName(),
+            unsigned fontFlags = ffBold);
         
         //! Returns the name of the font that was used to create it.
         std::wstring name() const;
@@ -70,10 +71,13 @@ namespace Gosu
         void setImage(wchar_t wc, const Gosu::Image& image);
         
         #ifndef SWIG
+        GOSU_DEPRECATED Font(Graphics& graphics, const std::wstring& fontName,
+            unsigned fontHeight, unsigned fontFlags = ffBold);
+        
         GOSU_DEPRECATED
         #endif
-        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle. Use 
-        //! a simple pushTransform to achieve the same effect.
+        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle.
+        //! Use Graphics::pushTransform to achieve the same effect.
         void drawRot(const std::wstring& text, double x, double y, ZPos z, double angle,
             double factorX = 1, double factorY = 1,
             Color c = Color::WHITE, AlphaMode mode = amDefault) const;

data/Gosu/Graphics.hpp

@@ -12,6 +12,8 @@
 
 namespace Gosu
 {
+    struct DrawOp;
+    
     //! Returns the maximum size of an texture that will be allocated
     //! internally by Gosu.
     //! Useful when extending Gosu using OpenGL.
@@ -20,9 +22,15 @@ namespace Gosu
     //! Serves as the target of all drawing and provides primitive drawing
     //! functionality.
     //! Usually created internally by Gosu::Window.
+    //
+    // TODO: This class should be separated into a Gosu::Viewport class, which
+    // carries the width/height/fullscreen attributes, and global Gosu::drawFoo
+    // functions. A Window then has a Viewport, and in theory, multiple windows
+    // could have their own viewports etc.
     class Graphics
     {
         struct Impl;
+        
         const GOSU_UNIQUE_PTR<Impl> pimpl;
         
     #if defined(GOSU_CPP11_ENABLED)
@@ -37,7 +45,6 @@ namespace Gosu
         Graphics(unsigned physicalWidth, unsigned physicalHeight, bool fullscreen);
         ~Graphics();
 
-        // TODO: Replace by setBaseTransform()
         void setResolution(unsigned virtualWidth, unsigned virtualHeight,
             double horizontalBlackBarWidth = 0, double verticalBlackBarHeight = 0);
         
@@ -50,65 +57,68 @@ namespace Gosu
         bool begin(Color clearWithColor = Color::BLACK);
         //! Every call to begin must have a matching call to end.
         void end();
+        
         //! Flushes the Z queue to the screen and starts a new one.
         //! Useful for games that are *very* composite in nature (splitscreen).
-        void flush();
+        static void flush();
         
         //! Finishes all pending Gosu drawing operations and executes
         //! the following OpenGL code in a clean environment.
-        void beginGL();
+        static void beginGL();
         //! Resets Gosu into its default rendering state.
-        void endGL();
+        static void endGL();
         //! Schedules a custom GL functor to be executed at a certain Z level.
         //! The functor is called in a clean GL context (as given by beginGL/endGL).
         //! Gosu's rendering up to the Z level may not yet have been glFlush()ed.
         //! Note: You may not call any Gosu rendering functions from within the
         //! functor, and you must schedule it from within Window::draw's call tree.
-        void scheduleGL(const std::tr1::function<void()>& functor, ZPos z);
+        static void scheduleGL(const std::tr1::function<void()>& functor, ZPos z);
         
         //! Enables clipping to a specified rectangle.
-        void beginClipping(double x, double y, double width, double height);
+        static void beginClipping(double x, double y, double width, double height);
         //! Disables clipping.
-        void endClipping();
+        static void endClipping();
         
         //! Starts recording a macro. Cannot be nested.
-        void beginRecording();
+        static void beginRecording();
         //! Finishes building the macro and returns it as a drawable object.
         //! The width and height affect nothing about the recording process,
         //! the resulting macro will simply return these values when you ask
         //! it.
         //! Most usually, the return value is passed to Image::Image().
-        GOSU_UNIQUE_PTR<Gosu::ImageData> endRecording(int width, int height);
+        static GOSU_UNIQUE_PTR<Gosu::ImageData> endRecording(int width, int height);
         
         //! Pushes one transformation onto the transformation stack.
-        void pushTransform(const Transform& transform);
+        static void pushTransform(const Transform& transform);
         //! Pops one transformation from the transformation stack.
-        void popTransform();
+        static void popTransform();
 
         //! 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
         //! or end point. Please only use this for debugging purposes. Otherwise, use a quad or
         //! image to simulate lines, or contribute a better drawLine to Gosu.
-        void drawLine(double x1, double y1, Color c1,
+        static void drawLine(double x1, double y1, Color c1,
             double x2, double y2, Color c2,
             ZPos z, AlphaMode mode = amDefault);
 
-        void drawTriangle(double x1, double y1, Color c1,
+        static void drawTriangle(double x1, double y1, Color c1,
             double x2, double y2, Color c2,
             double x3, double y3, Color c3,
             ZPos z, AlphaMode mode = amDefault);
 
-        void drawQuad(double x1, double y1, Color c1,
+        static void drawQuad(double x1, double y1, Color c1,
             double x2, double y2, Color c2,
             double x3, double y3, Color c3,
             double x4, double y4, Color c4,
             ZPos z, AlphaMode mode = amDefault);
+        
+        //! For internal use only.
+        static void scheduleDrawOp(const DrawOp& op);
 
-        //! Turns a portion of a bitmap into something that can be drawn on
-        //! this graphics object.
-        GOSU_UNIQUE_PTR<ImageData> createImage(const Bitmap& src,
+        //! Turns a portion of a bitmap into something that can be drawn on a Graphics object.
+        static GOSU_UNIQUE_PTR<ImageData> createImage(const Bitmap& src,
             unsigned srcX, unsigned srcY, unsigned srcWidth, unsigned srcHeight,
-            unsigned borderFlags);
+            unsigned imageFlags);
     };
 }
 

data/Gosu/GraphicsBase.hpp

@@ -31,11 +31,11 @@ namespace Gosu
         //! The color's channels will be multiplied with each other.
         MULTIPLY
     };
-    GOSU_DEPRECATED constexpr AlphaMode amDefault = AlphaMode::DEFAULT;
-    GOSU_DEPRECATED constexpr AlphaMode amInterpolate = AlphaMode::INTERPOLATE;
-    GOSU_DEPRECATED constexpr AlphaMode amAdd = AlphaMode::ADD;
-    GOSU_DEPRECATED constexpr AlphaMode amAdditive = AlphaMode::ADD;
-    GOSU_DEPRECATED constexpr AlphaMode amMultiply = AlphaMode::MULTIPLY;
+    constexpr AlphaMode amDefault = AlphaMode::DEFAULT;
+    constexpr AlphaMode amInterpolate = AlphaMode::INTERPOLATE;
+    constexpr AlphaMode amAdd = AlphaMode::ADD;
+    constexpr AlphaMode amAdditive = AlphaMode::ADD;
+    constexpr AlphaMode amMultiply = AlphaMode::MULTIPLY;
 #else
     enum AlphaMode
     {
@@ -68,15 +68,19 @@ namespace Gosu
         taJustify
     };
     
-    //! Flags that affect the tileability of an image.
-    enum BorderFlags
+    enum ImageFlags
     {
-        bfSmooth = 0,
-        bfTileableLeft = 1,
-        bfTileableTop = 2,
-        bfTileableRight = 4,
-        bfTileableBottom = 8,
-        bfTileable = bfTileableLeft | bfTileableTop | bfTileableRight | bfTileableBottom
+        //! Flags that affect the tileability of an image.
+        ifSmooth = 0,
+        // Note: No constant for '1', but Gosu treats '1' as ifTileable for
+        // backward compatibility reasons (this used to be a bool).
+        ifTileableLeft = 2,
+        ifTileableTop = 4,
+        ifTileableRight = 8,
+        ifTileableBottom = 16,
+        ifTileable = ifTileableLeft | ifTileableTop | ifTileableRight | ifTileableBottom
+        
+        // TODO - ifNearestNeighbor to replace undocumentedRetrofication.
     };
     
 #ifdef GOSU_IS_MAC

data/Gosu/Image.hpp

@@ -19,31 +19,29 @@ namespace Gosu
         std::tr1::shared_ptr<ImageData> data;
 
     public:
-        //! Loads an image from a given filename that can be drawn onto
-        //! graphics.
-        //! This constructor can handle PNG and BMP images. A color key of #ff00ff is
-        //! automatically applied to BMP type images. For more flexibility, use the
-        //! corresponding constructor that uses a Bitmap object.
-        Image(Graphics& graphics, const std::wstring& filename,
-              bool tileable = false);
-        //! Loads a portion of the the image at the given filename that can be
-        //! drawn onto graphics.
-        //! This constructor can handle PNG and BMP images. A color key of #ff00ff is
-        //! automatically applied to BMP type images. For more flexibility, use the
-        //! corresponding constructor that uses a Bitmap object.
-        Image(Graphics& graphics, const std::wstring& filename, unsigned srcX,
+        //! Loads an image from a given filename.
+        //!
+        //! A color key of #ff00ff is automatically applied to BMP image files.
+        //! For more flexibility, use the corresponding constructor that uses a Bitmap object.
+        explicit Image(const std::wstring& filename,
+            unsigned imageFlags = ifSmooth);
+        
+        //! Loads a portion of the the image at the given filename..
+        //!
+        //! A color key of #ff00ff is automatically applied to BMP image files.
+        //! For more flexibility, use the corresponding constructor that uses a Bitmap object.
+        Image(const std::wstring& filename, unsigned srcX,
               unsigned srcY, unsigned srcWidth, unsigned srcHeight,
-              bool tileable = false);
+              unsigned imageFlags = ifSmooth);
         
-        //! Converts the given bitmap into an image that can be drawn onto
-        //! graphics.
-        Image(Graphics& graphics, const Bitmap& source,
-            bool tileable = false);
-        //! Converts a portion of the given bitmap into an image that can be
-        //! drawn onto graphics.
-        Image(Graphics& graphics, const Bitmap& source, unsigned srcX,
+        //! Converts the given bitmap into an image.
+        explicit Image(const Bitmap& source,
+            unsigned imageFlags = ifSmooth);
+        
+        //! Converts a portion of the given bitmap into an image.
+        Image(const Bitmap& source, unsigned srcX,
             unsigned srcY, unsigned srcWidth, unsigned srcHeight,
-            bool tileable = false);
+            unsigned imageFlags = ifSmooth);
         
         //! Creates an Image from a user-supplied instance of the ImageData interface.
         explicit Image(GOSU_UNIQUE_PTR<ImageData> data);
@@ -56,8 +54,8 @@ namespace Gosu
             double factorX = 1, double factorY = 1,
             Color c = Color::WHITE,
             AlphaMode mode = amDefault) const;
-        //! Like draw(), but allows to give modulation colors for all four
-        //! corners.
+        //! Like draw(), but with modulation colors for all four corners.
+        //! TODO: This can be an overload of draw() - in any case the name is terrible.
         void drawMod(double x, double y, ZPos z,
             double factorX, double factorY,
             Color c1, Color c2, Color c3, Color c4,
@@ -77,46 +75,57 @@ namespace Gosu
             double factorX = 1, double factorY = 1,
             Color c = Color::WHITE,
             AlphaMode mode = amDefault) const;
-
+        
+        #ifndef SWIG
         //! Provides access to the underlying image data object.
         ImageData& getData() const;
+        
+        GOSU_DEPRECATED Image(Graphics& graphics, const std::wstring& filename,
+              bool tileable = false);
+        GOSU_DEPRECATED Image(Graphics& graphics, const std::wstring& filename, unsigned srcX,
+              unsigned srcY, unsigned srcWidth, unsigned srcHeight,
+              bool tileable = false);
+        GOSU_DEPRECATED Image(Graphics& graphics, const Bitmap& source,
+              bool tileable = false);
+        GOSU_DEPRECATED Image(Graphics& graphics, const Bitmap& source, unsigned srcX,
+              unsigned srcY, unsigned srcWidth, unsigned srcHeight,
+              bool tileable = false);
+        #endif
     };
     
-    std::vector<Gosu::Image> loadTiles(Graphics& graphics, const Bitmap& bmp, int tileWidth, int tileHeight, bool tileable);
-    std::vector<Gosu::Image> loadTiles(Graphics& graphics, const std::wstring& bmp, int tileWidth, int tileHeight, bool tileable);
+    #ifndef SWIG
+    //! Convenience function that slices an image file into a grid and creates images from them.
+    //! \param tileWidth If positive, specifies the width of one tile in pixels.
+    //! If negative, the bitmap is divided into -tileWidth rows.
+    //! \param tileHeight See tileWidth.
+    std::vector<Gosu::Image> loadTiles(const Bitmap& bmp,
+        int tileWidth, int tileHeight, unsigned imageFlags = ifSmooth);
     
-    //! Convenience function that splits a BMP or PNG file into an array
-    //! of small rectangles and creates images from them.
-    //! \param tileWidth If positive, specifies the width of one tile in
-    //! pixels. If negative, the bitmap is divided into -tileWidth rows.
+    //! Convenience function that slices a bitmap into a grid and creates images from them.
+    //! \param tileWidth If positive, specifies the width of one tile in pixels.
+    //! If negative, the bitmap is divided into -tileWidth rows.
     //! \param tileHeight See tileWidth.
-    //! \param appendTo STL container to which the images will be appended.
-    //! Must provide a push_back member function; vector<tr1::shared_ptr<Image>>
-    //! or boost::ptr_vector<Image> are good choices.
+    std::vector<Gosu::Image> loadTiles(const std::wstring& filename,
+        int tileWidth, int tileHeight, unsigned imageFlags = ifSmooth);
+    
+    GOSU_DEPRECATED std::vector<Gosu::Image> loadTiles(Graphics& graphics, const Bitmap& bmp, int tileWidth, int tileHeight, bool tileable);
+    GOSU_DEPRECATED std::vector<Gosu::Image> loadTiles(Graphics& graphics, const std::wstring& bmp, int tileWidth, int tileHeight, bool tileable);
     template<typename Container>
-    void imagesFromTiledBitmap(Graphics& graphics, const std::wstring& filename, int tileWidth, int tileHeight, bool tileable, Container& appendTo)
+    GOSU_DEPRECATED void imagesFromTiledBitmap(Graphics& graphics, const std::wstring& filename, int tileWidth, int tileHeight, bool tileable, Container& appendTo)
     {
         std::vector<Gosu::Image> tiles = loadTiles(graphics, filename, tileWidth, tileHeight, tileable);
         for (int i = 0, num = tiles.size(); i < num; ++i)
             appendTo.push_back(typename Container::value_type(new Gosu::Image(tiles[i])));
     }
-    
-    //! Convenience function that splits a bitmap into an area of array 
-    //! rectangles and creates images from them.
-    //! \param tileWidth If positive, specifies the width of one tile in
-    //! pixels. If negative, the bitmap is divided into -tileWidth rows.
-    //! \param tileHeight See tileWidth.
-    //! \param appendTo STL container to which the images will be appended.
-    //! Must provide a push_back member function; std::vector<std::tr1::shared_ptr<Image>>
-    //! or boost::ptr_vector<Image> are good choices.
     template<typename Container>
-    void imagesFromTiledBitmap(Graphics& graphics, const Bitmap& bmp,
+    GOSU_DEPRECATED void imagesFromTiledBitmap(Graphics& graphics, const Bitmap& bmp,
         int tileWidth, int tileHeight, bool tileable, Container& appendTo)
     {
         std::vector<Gosu::Image> tiles = loadTiles(graphics, bmp, tileWidth, tileHeight, tileable);
         for (int i = 0, num = tiles.size(); i < num; ++i)
             appendTo.push_back(typename Container::value_type(new Gosu::Image(tiles[i])));
     }
+    #endif
 }
 
 #endif

data/Gosu/Input.hpp

@@ -103,7 +103,7 @@ namespace Gosu
         
         //! Returns true if a button is currently pressed.
         //! Updated every tick.
-        bool down(Button btn) const;
+        static bool down(Button btn);
         
         //! Returns the horizontal position of the mouse relative to the top
         //! left corner of the window given to Input's constructor.
@@ -112,8 +112,8 @@ namespace Gosu
         double mouseY() const;
         
         //! Immediately moves the mouse as far towards the desired position
-        //! as possible. x and y are relativ to the window just as in the mouse
-        //! position accessors.
+        //! as possible. x and y are relative to the window, just as in mouseX()
+        //! and mouseY(), so (0, 0) is the top left corner of the window..
         void setMousePosition(double x, double y);
 
         // Undocumented for the moment. Also applies to currentTouches().
@@ -132,11 +132,11 @@ namespace Gosu
         void update();
         
         //! Assignable events that are called by update. You can bind these to your own functions.
-        //! If you use the Window class, it will assign forward these to its own methods.
+        //! If you use the Window class, it will assign these to its own methods.
         std::tr1::function<void (Button)> onButtonDown, onButtonUp;
         
         //! Assignable events that are called by update. You can bind these to your own functions.
-        //! If you use the Window class, it will assign forward these to its own methods.
+        //! If you use the Window class, it will assign these to its own methods.
         std::tr1::function<void (Touch)> onTouchBegan, onTouchMoved, onTouchEnded;
         
         //! Returns the currently active TextInput instance, or 0.

data/Gosu/Version.hpp

@@ -2,9 +2,9 @@
 #define GOSU_VERSION_HPP
 
 #define GOSU_MAJOR_VERSION 0
-#define GOSU_MINOR_VERSION 8
-#define GOSU_POINT_VERSION 7
-#define GOSU_VERSION "0.8.7"
+#define GOSU_MINOR_VERSION 9
+#define GOSU_POINT_VERSION 0
+#define GOSU_VERSION "0.9.0.pre1"
 
 #define GOSU_COPYRIGHT_NOTICE \
     "This software uses the following third-party libraries:\n" \

data/Gosu/Window.hpp

@@ -57,7 +57,7 @@ namespace Gosu
         //! \param height See width.
         //! \param updateInterval Interval in milliseconds between two calls
         //! to the update member function.
-        Window(unsigned width, unsigned height, bool fullscreen,
+        Window(unsigned width, unsigned height, bool fullscreen = false,
             double updateInterval = 16.666666);
         virtual ~Window();
 
@@ -113,13 +113,6 @@ namespace Gosu
         const Input& input() const;
         Input& input();
         
-        #ifdef GOSU_IS_UNIX
-        // Context for creating shared contexts.
-        // Only on Unices (so far).
-        typedef std::tr1::shared_ptr<std::tr1::function<void()> > SharedContext;
-        SharedContext createSharedContext();
-        #endif
-        
         #ifdef GOSU_IS_IPHONE
         void* rootViewController() const;
         // iPhone-only callbacks for touch events.