gosu 0.8.6-x64-mingw32

data/Gosu/Color.hpp

@@ -0,0 +1,204 @@
+//! \file Color.hpp
+//! Interface of the Color class.
+
+#ifndef GOSU_COLOR_HPP
+#define GOSU_COLOR_HPP
+
+#include <Gosu/Platform.hpp>
+#include <Gosu/TR1.hpp>
+
+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 interpretation is 0xrrggbbaa, on Little-Endian machines
+    //! it is 0xaabbggrr.
+    class Color
+    {
+        std::tr1::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::tr1::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)
+        {
+            *this = Color((argb >> 24) & 0xff, (argb >> 16) & 0xff,
+                          (argb >>  8) & 0xff, (argb >>  0) & 0xff);
+        }
+        
+        Color(Channel red, Channel green, Channel blue)
+        {
+            *this = 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.
+        //! The alpha value is set to 1 from this method.
+        static Color fromHSV(double h, double s, double v);
+        static Color fromAHSV(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);
+        }
+
+        Channel blue() const
+        {
+            return static_cast<Channel>(rep >> BLUE_OFFSET);
+        }
+
+        Channel alpha() const
+        {
+            return static_cast<Channel>(rep >> ALPHA_OFFSET);
+        }
+
+        void setRed(Channel value)
+        {
+            rep &= ~(0xff << RED_OFFSET);
+            rep |= value << RED_OFFSET;
+        }
+
+        void setGreen(Channel value)
+        {
+            rep &= ~(0xff << GREEN_OFFSET);
+            rep |= value << GREEN_OFFSET;
+        }
+
+        void setBlue(Channel value)
+        {
+            rep &= ~(0xff << BLUE_OFFSET);
+            rep |= value << BLUE_OFFSET;
+        }
+
+        void setAlpha(Channel value)
+        {
+            rep &= ~(0xff << ALPHA_OFFSET);
+            rep |= value << ALPHA_OFFSET;
+        }
+
+        //! 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.
+        void setHue(double h);
+        
+        //! Returns the saturation of the color, in the range of 0..1.
+        double saturation() const;
+        
+        //! Changes the current color so saturation() will return s.
+        void setSaturation(double s);
+        
+        //! 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.
+        void setValue(double v);
+
+        //! Returns the color in 0xaarrggbb representation.
+        std::tr1::uint32_t argb() const
+        {
+            return alpha() << 24 | red() << 16 | green() << 8 | blue();
+        }
+
+        //! Returns the color in 0x00bbggrr representation. Useful for Win32 programming.
+        std::tr1::uint32_t bgr() const
+        {
+            return blue() << 16 | green() << 8 | red();
+        }
+
+        //! Returns the color in 0xaabbggrr representation.
+        std::tr1::uint32_t abgr() const
+        {
+            return alpha() << 24 | blue() << 16 | green() << 8 | red();
+        }
+        
+        //! Returns the internal representation of the color (RGBA in memory).
+        std::tr1::uint32_t gl() const
+        {
+            return rep;
+        }
+        
+        static const Color NONE;
+        static const Color BLACK;
+        static const Color GRAY;
+        static const Color WHITE;
+        
+        static const Color AQUA;
+        static const Color RED;
+        static const Color GREEN;
+        static const Color BLUE;
+        static const Color YELLOW;
+        static const Color FUCHSIA;
+        static const Color CYAN;
+    };
+    
+    #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);
+    
+    //! 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);
+
+    namespace Colors
+    {
+        GOSU_DEPRECATED const Color none     (0x00000000);
+        GOSU_DEPRECATED const Color black    (0xff000000);
+        GOSU_DEPRECATED const Color gray     (0xff808080);
+        GOSU_DEPRECATED const Color white    (0xffffffff);
+        
+        GOSU_DEPRECATED const Color aqua     (0xff00ffff);
+        GOSU_DEPRECATED const Color red      (0xffff0000);
+        GOSU_DEPRECATED const Color green    (0xff00ff00);
+        GOSU_DEPRECATED const Color blue     (0xff0000ff);
+        GOSU_DEPRECATED const Color yellow   (0xffffff00);
+        GOSU_DEPRECATED const Color fuchsia  (0xffff00ff);
+        GOSU_DEPRECATED const Color cyan     (0xff00ffff);
+    }
+    #endif
+}
+
+#endif

data/Gosu/Directories.hpp

@@ -0,0 +1,36 @@
+//! \file Directories.hpp
+//! Access to a small set of system paths.
+
+#ifndef GOSU_DIRECTORIES_HPP
+#define GOSU_DIRECTORIES_HPP
+
+#include <string>
+
+namespace Gosu
+{
+    //! Prefix for a program's own resources.
+    //! On Windows, the executable's containing directory.
+    //! On OS X, the application's Resources subdirectory.
+    //! On Linux, the current directory.
+    std::wstring resourcePrefix();
+    
+    //! Prefix for resources of a group of programs.
+    //! On Windows, the executable's containing directory.
+    //! On OS X, the application's containing subdirectory.
+    //! On Linux, the current directory.
+    std::wstring sharedResourcePrefix();
+    
+    //! Prefix for user settings.
+    //! On Windows, the same as %APPDATA%.
+    //! On OS X, the user's Library/Preferences folder.
+    //! On Linux, the home directory plus a trailing dot for hidden files.
+    std::wstring userSettingsPrefix();
+    
+    //! Prefix for user documents, e.g. save games.
+    //! On Windows, the My Documents folder.
+    //! On OS X, the user's Documents folder.
+    //! On Linux, the home directory.
+    std::wstring userDocsPrefix();
+}
+
+#endif

data/Gosu/Font.hpp

@@ -0,0 +1,83 @@
+//! \file Font.hpp
+//! Interface of the Font class.
+
+#ifndef GOSU_FONT_HPP
+#define GOSU_FONT_HPP
+
+#include <Gosu/Fwd.hpp>
+#include <Gosu/Color.hpp>
+#include <Gosu/GraphicsBase.hpp>
+#include <Gosu/Platform.hpp>
+#include <Gosu/TR1.hpp>
+#include <string>
+
+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 createBitmap and turn the result into
+    //! an image.
+    class Font
+    {
+        struct Impl;
+        std::tr1::shared_ptr<Impl> pimpl;
+
+    public:
+        //! Constructs a font that can be drawn onto the graphics object.
+        //! \param fontName Name of a system font, or a filename to a TTF
+        //!        file (must contain '/', does not work on Linux).
+        //! \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);
+        
+        //! Returns the name of the font that was used to create it.
+        std::wstring name() const;
+        
+        //! Returns the height of the font, in pixels.
+        unsigned height() const;
+        
+        //! Returns the flags used to create the font characters.
+        unsigned flags() const;
+        
+        //! Returns the width, in pixels, the given text would occupy if drawn.
+        double textWidth(const std::wstring& text, double factorX = 1) 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::wstring& text, double x, double y, ZPos z,
+            double factorX = 1, double factorY = 1,
+            Color c = Color::WHITE, AlphaMode mode = amDefault) const;
+        
+        //! Draws text at a position relative to (x; y).
+        //! \param relX Determines where the text is drawn horizontally. If
+        //! relX 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.
+        //! \param relY See relX.
+        void drawRel(const std::wstring& text, double x, double y, ZPos z,
+            double relX, double relY, double factorX = 1, double factorY = 1,
+            Color c = Color::WHITE, AlphaMode mode = amDefault) 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.
+        void setImage(wchar_t wc, unsigned fontFlags, const Gosu::Image& image);
+        //! A shortcut for mapping a character to an image regardless of fontFlags.
+        //! Later versions might apply faux italics or faux bold to it (to be decided!).
+        void setImage(wchar_t wc, const Gosu::Image& image);
+        
+        #ifndef SWIG
+        GOSU_DEPRECATED
+        #endif
+        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle. Use 
+        //! a simple 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;
+    };
+}
+
+#endif

data/Gosu/Fwd.hpp

@@ -0,0 +1,31 @@
+//! \file Fwd.hpp
+//! Contains declarations of all of Gosu's available classes.
+
+#ifndef GOSU_FWD_HPP
+#define GOSU_FWD_HPP
+
+//! The library's main namespace.
+namespace Gosu
+{
+    class Audio;
+    class Bitmap;
+    class Buffer;
+    class Button;
+    class Color;
+    class File;
+    class Font;
+    class Graphics;
+    class Image;
+    class ImageData;
+    class Input;
+    class Reader;
+    class Resource;
+    class Sample;
+    class Song;
+    class TextInput;
+    class Timer;
+    class Window;
+    class Writer;
+}
+
+#endif

data/Gosu/Gosu.hpp

@@ -0,0 +1,34 @@
+//! \file Gosu.hpp
+//! Umbrella header for lazy people with fast compilers, or pre-compiled headers.
+
+//! \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, http://www.libgosu.org/.
+
+#ifndef GOSU_GOSU_HPP
+#define GOSU_GOSU_HPP
+
+#include <Gosu/Audio.hpp>
+#include <Gosu/Bitmap.hpp>
+#include <Gosu/Color.hpp>
+#include <Gosu/Directories.hpp>
+#include <Gosu/Font.hpp>
+#include <Gosu/Graphics.hpp>
+#include <Gosu/Image.hpp>
+#include <Gosu/ImageData.hpp>
+#include <Gosu/Input.hpp>
+#include <Gosu/Inspection.hpp>
+#include <Gosu/IO.hpp>
+#include <Gosu/Math.hpp>
+#include <Gosu/Platform.hpp>
+#include <Gosu/Sockets.hpp>
+#include <Gosu/Text.hpp>
+#include <Gosu/TextInput.hpp>
+#include <Gosu/Timing.hpp>
+#include <Gosu/Utility.hpp>
+#include <Gosu/Version.hpp>
+#include <Gosu/Window.hpp>
+
+#endif

data/Gosu/Graphics.hpp

@@ -0,0 +1,115 @@
+//! \file Graphics.hpp
+//! Interface of the Graphics class.
+
+#ifndef GOSU_GRAPHICS_HPP
+#define GOSU_GRAPHICS_HPP
+
+#include <Gosu/Fwd.hpp>
+#include <Gosu/Color.hpp>
+#include <Gosu/GraphicsBase.hpp>
+#include <Gosu/TR1.hpp>
+#include <memory>
+
+namespace Gosu
+{
+    //! Returns the maximum size of an texture that will be allocated
+    //! internally by Gosu.
+    //! Useful when extending Gosu using OpenGL.
+    unsigned const MAX_TEXTURE_SIZE = 1024;
+    
+    //! Serves as the target of all drawing and provides primitive drawing
+    //! functionality.
+    //! Usually created internally by Gosu::Window.
+    class Graphics
+    {
+        struct Impl;
+        const GOSU_UNIQUE_PTR<Impl> pimpl;
+        
+    #if defined(GOSU_CPP11_ENABLED)
+        // explicitly forbid copying and moving
+        Graphics(Graphics&&) = delete;
+        Graphics& operator=(Graphics&&) = delete;
+        Graphics(const Graphics&) = delete;
+        Graphics& operator=(const Graphics&) = delete;
+    #endif
+
+    public:
+        Graphics(unsigned physicalWidth, unsigned physicalHeight, bool fullscreen);
+        ~Graphics();
+
+        // TODO: Replace by setBaseTransform()
+        void setResolution(unsigned virtualWidth, unsigned virtualHeight,
+            double horizontalBlackBarWidth = 0, double verticalBlackBarHeight = 0);
+        
+        unsigned width() const;
+        unsigned height() const;
+        bool fullscreen() const;
+
+        //! Prepares the graphics object for drawing. Nothing must be drawn
+        //! without calling begin.
+        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();
+        
+        //! Finishes all pending Gosu drawing operations and executes
+        //! the following OpenGL code in a clean environment.
+        void beginGL();
+        //! Resets Gosu into its default rendering state.
+        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);
+        
+        //! Enables clipping to a specified rectangle.
+        void beginClipping(double x, double y, double width, double height);
+        //! Disables clipping.
+        void endClipping();
+        
+        //! Starts recording a macro. Cannot be nested.
+        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);
+        
+        //! Pushes one transformation onto the transformation stack.
+        void pushTransform(const Transform& transform);
+        //! Pops one transformation from the transformation stack.
+        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,
+            double x2, double y2, Color c2,
+            ZPos z, AlphaMode mode = amDefault);
+
+        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,
+            double x2, double y2, Color c2,
+            double x3, double y3, Color c3,
+            double x4, double y4, Color c4,
+            ZPos z, AlphaMode mode = amDefault);
+
+        //! Turns a portion of a bitmap into something that can be drawn on
+        //! this graphics object.
+        GOSU_UNIQUE_PTR<ImageData> createImage(const Bitmap& src,
+            unsigned srcX, unsigned srcY, unsigned srcWidth, unsigned srcHeight,
+            unsigned borderFlags);
+    };
+}
+
+#endif