texture_group.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Kenneth Gangstoe
00027 **    Magnus Norddahl
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_display.h"
00036 #include "../../Core/System/sharedptr.h"
00037 
00038 class CL_Size;
00039 class CL_Rect;
00040 class CL_Texture;
00041 class CL_Subtexture;
00042 class CL_TextureGroup_Impl;
00043 class CL_GraphicContext;
00044 
00048 class CL_API_DISPLAY CL_TextureGroup
00049 {
00052 public:
00054         enum TextureAllocationPolicy
00055         {
00056                 create_new_texture,
00057                 search_previous_textures
00058         };
00059 
00063 public:
00065         CL_TextureGroup();
00066 
00068         CL_TextureGroup(const CL_Size &texture_sizes);
00069 
00070         ~CL_TextureGroup();
00071 
00075 public:
00076 
00078         bool is_null() const { return !impl; }
00079 
00081         void throw_if_null() const;
00082 
00084         int get_subtexture_count() const;
00085 
00087         int get_subtexture_count(unsigned int texture_index) const;
00088 
00090         int get_texture_count() const;
00091 
00093         TextureAllocationPolicy get_texture_allocation_policy() const;
00094 
00096         CL_Size get_texture_sizes() const;
00097 
00099         std::vector<CL_Texture> get_textures() const;
00100 
00104 public:
00106         CL_Subtexture add(CL_GraphicContext &context, const CL_Size &size);
00107 
00113         void remove(CL_Subtexture &subtexture);
00114 
00116         void set_texture_allocation_policy(TextureAllocationPolicy policy);
00117 
00122         void insert_texture(CL_Texture &texture, const CL_Rect &texture_rect);
00123 
00127 private:
00128         CL_SharedPtr<CL_TextureGroup_Impl> impl;
00130 };
00131