path: root/src/menu/background_image.hpp

/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef BACKGROUND_IMAGE_HPP
#define BACKGROUND_IMAGE_HPP

#include <boost/filesystem.hpp>
#include <GL/gl.h>

#include "background.hpp"
#include "texture.hpp"
#include "utils/disposer.hpp"
#include "utils/dimension.hpp"

namespace usdx
{
	/**
	 * This class draws an image as background for the drawable control an
	 * instance of this class is attached to.
	 */
	class BackgroundImage : public Background
	{
	private:
		/**
		 * Texture containing the image, that should be used as background.
		 */
		Disposer<Texture>* texture;

		/**
		 * Vertices to draw the background rectangle filled with the
		 * texture. Cached until size of the parent component changes.
		 *
		 * @see updateVertices()
		 */
		GLint vertices[8];

		/**
		 * Cache for the size of the parent component, to be able to detect
		 * changes.
		 */
		Dimension<int> size;

		/**
		 * Update the vertices for drawing the background, if the size if the
		 * parent component changes.
		 */
		void updateVertices();

	protected:
		void draw(void);

	public:
		BackgroundImage(const DrawableControl &control,
						boost::filesystem::wpath filename);

		virtual ~BackgroundImage();
	};
};


#endif