Source

love / src / modules / graphics / opengl / OpenGL.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_OPENGL_H
#define LOVE_GRAPHICS_OPENGL_OPENGL_H

#include "GLee.h"
#include "graphics/Image.h"

namespace love
{
namespace graphics
{
namespace opengl
{

/**
 * Initializes some required context state,
 * based on current and default OpenGL state.
 **/
void initializeContext();

/**
 * Marks current context state as invalid.
 **/
void uninitializeContext();

/**
 * Helper for setting the active texture unit.
 *
 * @param textureunit Index in the range of [0, maxtextureunits-1]
 **/
void setActiveTextureUnit(int textureunit);

/**
 * Helper for binding an OpenGL texture.
 * Makes sure we aren't redundantly binding textures.
 **/
void bindTexture(GLuint texture);

/**
 * Helper for binding a texture to a specific texture unit.
 *
 * @param textureunit Index in the range of [0, maxtextureunits-1]
 * @param resoreprev Restore previously bound texture unit when done.
 **/
void bindTextureToUnit(GLuint texture, int textureunit, bool restoreprev);

/**
 * Helper for deleting an OpenGL texture.
 * Cleans up if the texture is currently bound.
 **/
void deleteTexture(GLuint texture);

/**
 * Sets the image filter mode for the currently bound texture.
 */
void setTextureFilter(const graphics::Image::Filter &f);

/**
 * Returns the image filter mode for the currently bound texture.
 */
graphics::Image::Filter getTextureFilter();

/**
 * Sets the image wrap mode for the currently bound texture.
 */
void setTextureWrap(const graphics::Image::Wrap &w);

/**
 * Returns the image wrap mode for the currently bound texture.
 */
graphics::Image::Wrap getTextureWrap();

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

#endif