love/src/modules/graphics/opengl/Graphics.h

/**
 * Copyright (c) 2006-2013 LOVE Development Team
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 **/

#ifndef LOVE_GRAPHICS_OPENGL_GRAPHICS_H
#define LOVE_GRAPHICS_OPENGL_GRAPHICS_H

// STD
#include <iostream>
#include <cmath>

// OpenGL
#include "OpenGL.h"

// LOVE
#include "graphics/Graphics.h"
#include "graphics/Color.h"

#include "image/Image.h"
#include "image/ImageData.h"

#include "window/Window.h"

#include "Font.h"
#include "Image.h"
#include "graphics/Geometry.h"
#include "SpriteBatch.h"
#include "ParticleSystem.h"
#include "Canvas.h"
#include "Shader.h"

using love::window::WindowFlags;

namespace love
{
namespace graphics
{
namespace opengl
{

// During display mode changing, certain
// variables about the OpenGL context are
// lost.
struct DisplayState
{
	// Colors.
	Color color;
	Color backgroundColor;

	// Blend mode.
	Graphics::BlendMode blendMode;

	// Line.
	Graphics::LineStyle lineStyle;

	// Point.
	float pointSize;
	Graphics::PointStyle pointStyle;

	bool alphaTest;
	Graphics::AlphaTestMode alphaTestMode;
	unsigned char alphaTestRef;

	// Scissor.
	bool scissor;
	GLint scissorBox[4];

	// Color mask.
	bool colorMask[4];

	// Default values.
	DisplayState()
	{
		color.set(255,255,255,255);
		backgroundColor.r = 0;
		backgroundColor.g = 0;
		backgroundColor.b = 0;
		backgroundColor.a = 255;
		blendMode = Graphics::BLEND_ALPHA;
		lineStyle = Graphics::LINE_SMOOTH;
		pointSize = 1.0f;
		pointStyle = Graphics::POINT_SMOOTH;
		alphaTest = false;
		scissor = false;
		colorMask[0] = colorMask[1] = colorMask[2] = colorMask[3] = true;
	}

};

class Graphics : public love::graphics::Graphics
{
public:

	Graphics();
	virtual ~Graphics();

	// Implements Module.
	const char *getName() const;

	/**
	 * Checks whether a display mode is supported or not. Note
	 * that fullscreen is assumed, because windowed modes are
	 * generally supported regardless of size.
	 * @param width The window width.
	 * @param height The window height.
	 **/
	bool checkMode(int width, int height, bool fullscreen) const;

	DisplayState saveState();

	void restoreState(const DisplayState &s);

	/**
	 * Sets the current display mode.
	 * @param width The window width.
	 * @param height The window height.
	 * @param flags An optional WindowFlags structure.
	 **/
	bool setMode(int width, int height, WindowFlags *flags);

	/**
	 * Gets the current display mode.
	 * @param width Pointer to an integer for the window width.
	 * @param height Pointer to an integer for the window height.
	 * @param flags A WindowFlags structure.
	 **/
	void getMode(int &width, int &height, WindowFlags &flags) const;

	/**
	 * Toggles fullscreen. Note that this also needs to reload the
	 * entire OpenGL context.
	 **/
	bool toggleFullscreen();

	/**
	 * Resets the current color, background color,
	 * line style, and so forth. (This will be called
	 * when the game reloads.
	 **/
	void reset();

	/**
	 * Clears the screen.
	 **/
	void clear();

	/**
	 * Flips buffers. (Rendered geometry is
	 * presented on screen).
	 **/
	void present();

	/**
	 * Sets the window's icon.
	 **/
	void setIcon(Image *image);

	/**
	 * Sets the window's caption.
	 **/
	void setCaption(const char *caption);

	/**
	 * Gets the window's caption.
	 **/
	std::string getCaption() const;

	/**
	 * Gets the width of the current display mode.
	 **/
	int getWidth() const;

	/**
	 * Gets the height of the current display mode.
	 **/
	int getHeight() const;

	/**
	 * True if some display mode is set.
	 **/
	bool isCreated() const;

	/**
	 * This native Lua function gets available modes
	 * from SDL and returns them as a table on the following format:
	 *
	 * {
	 *   { width = 800, height = 600 },
	 *   { width = 1024, height = 768 },
	 *   ...
	 * }
	 *
	 * Only fullscreen modes are returned here, as all
	 * window sizes are supported (normally).
	 **/
	int getModes(lua_State *L) const;

	/**
	 * Scissor defines a box such that everything outside that box is discarded and not drawn.
	 * Scissoring is automatically enabled.
	 * @param x The x-coordinate of the top-left corner.
	 * @param y The y-coordinate of the top-left corner.
	 * @param width The width of the box.
	 * @param height The height of the box.
	 **/
	void setScissor(int x, int y, int width, int height);

	/**
	 * Clears any scissor that has been created.
	 **/
	void setScissor();

	/**
	 * This native Lua function gets the current scissor box in the order of:
	 * x, y, width, height
	 **/
	int getScissor(lua_State *L) const;

	/**
	 * Enables the stencil buffer and set stencil function to fill it
	 */
	void defineStencil();

	/**
	 * Set stencil function to mask the following drawing calls using
	 * the current stencil buffer
	 * @param invert Invert the mask, i.e. draw everywhere expect where
	 *               the mask is defined.
	 */
	void useStencil(bool invert = false);

	/**
	 * Disables the stencil buffer
	 */
	void discardStencil();

	/**
	 * Enables alpha testing for all following draw calls
	 * @param mode The alpha comparison mode used when performing the alpha test
	 * @param refalpha The reference alpha value used when perfoming the alpha test
	 */
	void setAlphaTest(Graphics::AlphaTestMode mode, unsigned char refalpha);

	/**
	 * Disables alpha testing
	 */
	void setAlphaTest();

	/**
	 * True if alpha testing is enabled
	 */
	bool isAlphaTestEnabled();

	/**
	 * Gets the current alpha test comparison mode
	 */
	Graphics::AlphaTestMode getAlphaTestMode();

	/**
	 * Gets the current alpha test reference alpha value (0-255)
	 */
	unsigned char getAlphaTestRef();

	/**
	 * Creates an Image object with padding and/or optimization.
	 **/
	Image *newImage(love::image::ImageData *data);
	Image *newImage(love::image::CompressedData *cdata);

	/**
	 * Creates a Geometry object.
	 **/
	Geometry *newGeometry(const std::vector<vertex> &vertices);

	/**
	 * Creates a quadliteral Geometry object.
	 **/
	Geometry *newQuad(float x, float y, float w, float h, float sw, float sh);

	/**
	 * Creates a Font object.
	 **/
	Font *newFont(love::font::Rasterizer *data, const Image::Filter &filter = Image::Filter());

	SpriteBatch *newSpriteBatch(Image *image, int size, int usage);

	ParticleSystem *newParticleSystem(Image *image, int size);

	Canvas *newCanvas(int width, int height, Canvas::TextureType texture_type = Canvas::TYPE_NORMAL);

	Shader *newShader(const Shader::ShaderSources &sources);

	/**
	 * Sets the foreground color.
	 * @param c The new foreground color.
	 **/
	void setColor(const Color &c);

	/**
	 * Gets current color.
	 **/
	Color getColor() const;

	/**
	 * Sets the background Color.
	 **/
	void setBackgroundColor(const Color &c);

	/**
	 * Gets the current background color.
	 **/
	Color getBackgroundColor() const;

	/**
	 * Sets the current font.
	 * @param font A Font object.
	 **/
	void setFont(Font *font);
	/**
	 * Gets the current Font, or nil if none.
	 **/
	Font *getFont() const;

	/**
	 * Sets the enabled color components when rendering.
	 **/
	void setColorMask(bool r, bool g, bool b, bool a);

	/**
	 * Gets the current color mask.
	 * Returns an array of 4 booleans representing the mask.
	 **/
	const bool *getColorMask() const;

	/**
	 * Sets the current blend mode.
	 **/
	void setBlendMode(BlendMode mode);

	/**
	 * Gets the current blend mode.
	 **/
	BlendMode getBlendMode() const;

	/**
	 * Sets the default filter for images, canvases, and fonts.
	 **/
	void setDefaultFilter(const Image::Filter &f);

	/**
	 * Gets the default filter for images, canvases, and fonts.
	 **/
	const Image::Filter &getDefaultFilter() const;

	/**
	 * Default Image mipmap filter mode and sharpness values.
	 **/
	void setDefaultMipmapFilter(Image::FilterMode filter, float sharpness);
	void getDefaultMipmapFilter(Image::FilterMode *filter, float *sharpness) const;

	/**
	 * Sets the line width.
	 * @param width The new width of the line.
	 **/
	void setLineWidth(float width);

	/**
	 * Sets the line style.
	 * @param style LINE_ROUGH or LINE_SMOOTH.
	 **/
	void setLineStyle(LineStyle style);

	/**
	 * Sets the type of line used to draw primitives.
	 * A shorthand for setLineWidth and setLineStyle.
	 **/
	void setLine(float width, LineStyle style);

	/**
	 * Gets the line width.
	 **/
	float getLineWidth() const;

	/**
	 * Gets the line style.
	 **/
	LineStyle getLineStyle() const;

	/**
	 * Sets the size of points.
	 **/
	void setPointSize(float size);

	/**
	 * Sets the style of points.
	 * @param style POINT_SMOOTH or POINT_ROUGH.
	 **/
	void setPointStyle(PointStyle style);

	/**
	 * Shorthand for setPointSize and setPointStyle.
	 **/
	void setPoint(float size, PointStyle style);

	/**
	 * Gets the point size.
	 **/
	float getPointSize() const;

	/**
	 * Gets the point style.
	 **/
	PointStyle getPointStyle() const;

	/**
	 * Gets the maximum point size supported.
	 * This may vary from computer to computer.
	 **/
	int getMaxPointSize() const;

	/**
	 * Draws text at the specified coordinates, with rotation and
	 * scaling along both axes.
	 * @param x The x-coordinate.
	 * @param y The y-coordinate.
	 * @param angle The amount of rotation.
	 * @param sx The scale factor along the x-axis. (1 = normal).
	 * @param sy The scale factor along the y-axis. (1 = normal).
	 * @param ox The origin offset along the x-axis.
	 * @param oy The origin offset along the y-axis.
	 * @param kx Shear along the x-axis.
	 * @param ky Shear along the y-axis.
	 **/
	void print(const char *str, float x, float y, float angle, float sx, float sy, float ox, float oy, float kx, float ky);

	/**
	 * Draw formatted text on screen at the specified coordinates.
	 *
	 * @param str A string of text.
	 * @param x The x-coordinate.
	 * @param y The y-coordinate.
	 * @param wrap The maximum width of the text area.
	 * @param align Where to align the text.
	 * @param angle The amount of rotation.
	 * @param sx The scale factor along the x-axis. (1 = normal).
	 * @param sy The scale factor along the y-axis. (1 = normal).
	 * @param ox The origin offset along the x-axis.
	 * @param oy The origin offset along the y-axis.
	 * @param kx Shear along the x-axis.
	 * @param ky Shear along the y-axis.
	 **/
	void printf(const char *str, float x, float y, float wrap, AlignMode align, float angle, float sx, float sy, float ox, float oy, float kx, float ky);

	/**
	 * Draws a point at (x,y).
	 * @param x Point along x-axis.
	 * @param y Point along y-axis.
	 **/
	void point(float x, float y);

	/**
	 * Draws a series of lines connecting the given vertices.
	 * @param coords Vertex components (x1, y1, ..., xn, yn). If x1,y1 == xn,yn the line will be drawn closed.
	 * @param count Number of items in the array, i.e. count = 2 * n
	 **/
	void polyline(const float *coords, size_t count);

	/**
	 * Draws a rectangle.
	 * @param x Position along x-axis for top-left corner.
	 * @param y Position along y-axis for top-left corner.
	 * @param w The width of the rectangle.
	 * @param h The height of the rectangle.
	 **/
	void rectangle(DrawMode mode, float x, float y, float w, float h);

	/**
	 * Draws a circle using the specified arguments.
	 * @param mode The mode of drawing (line/filled).
	 * @param x X-coordinate.
	 * @param y Y-coordinate.
	 * @param radius Radius of the circle.
	 * @param points Number of points to use to draw the circle.
	 **/
	void circle(DrawMode mode, float x, float y, float radius, int points = 10);

	/**
	 * Draws an arc using the specified arguments.
	 * @param mode The mode of drawing (line/filled).
	 * @param x X-coordinate.
	 * @param y Y-coordinate.
	 * @param radius Radius of the arc.
	 * @param angle1 The angle at which the arc begins.
	 * @param angle2 The angle at which the arc terminates.
	 * @param points Number of points to use to draw the arc.
	 **/
	void arc(DrawMode mode, float x, float y, float radius, float angle1, float angle2, int points = 10);

	/**
	 * Draws a polygon with an arbitrary number of vertices.
	 * @param type The type of drawing (line/filled).
	 * @param coords Vertex components (x1, y1, x2, y2, etc.)
	 * @param count Coord array size
	 **/
	void polygon(DrawMode mode, const float *coords, size_t count);

	/**
	 * Creates a screenshot of the view and saves it to the default folder.
	 * @param image The love.image module.
	 * @param copyAlpha If the alpha channel should be copied or set to full opacity (255).
	 **/
	love::image::ImageData *newScreenshot(love::image::Image *image, bool copyAlpha = true);

	void push();
	void pop();
	void rotate(float r);
	void scale(float x, float y = 1.0f);
	void translate(float x, float y);
	void shear(float kx, float ky);
	void origin();

	bool hasFocus() const;
private:

	Font *currentFont;
	love::window::Window *currentWindow;

	LineStyle lineStyle;
	float lineWidth;
	GLint matrixLimit;
	GLint userMatrices;
	bool colorMask[4];

	int getRenderWidth() const;
	int getRenderHeight() const;

}; // Graphics

} // opengl
} // graphics
} // love

#endif // LOVE_GRAPHICS_OPENGL_GRAPHICS_H