texture.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 ** Harry Storbacka
28 */
29 
30 
31 #pragma once
32 
33 #include <memory>
34 #include "../../Core/IOData/file_system.h"
35 #include "../../Core/Resources/resource.h"
36 #include "graphic_context.h"
37 #include "../Image/image_import_description.h"
38 #include "../Image/texture_format.h"
39 
40 namespace clan
41 {
44 
45 class Color;
46 class Point;
47 class PixelBuffer;
48 class PixelBufferSet;
49 class PixelFormat;
50 class TextureProvider;
51 class DataBuffer;
52 class Texture1D;
53 class Texture1DArray;
54 class Texture2D;
55 class Texture2DArray;
56 class Texture3D;
57 class TextureCube;
58 class TextureCubeArray;
59 class Texture_Impl;
60 class SharedGCData_Impl;
61 class ResourceManager;
62 class XMLResourceDocument;
63 
66 {
70 };
71 
74 {
81 };
82 
85 {
88 };
89 
92 {
100 };
101 
103 class Texture
104 {
107 public:
110 
112  Texture(GraphicContext &gc, PixelBufferSet pixelbuffer_set);
113 
117  Texture(const std::shared_ptr<Texture_Impl> &impl);
118 
123 
124  virtual ~Texture();
126 
129 public:
135  static Resource<Texture> resource(GraphicContext &gc, const std::string &id, const ResourceManager &resources);
136 
138  static Texture load(GraphicContext &gc, const std::string &id, const XMLResourceDocument &doc, const ImageImportDescription &import_desc = ImageImportDescription());
140 
143 public:
145  bool operator==(const Texture &other) const
146  {
147  return impl==other.impl;
148  }
149 
151  bool operator!=(const Texture &other) const
152  {
153  return impl!=other.impl;
154  }
155 
157  bool operator<(const Texture &other) const
158  {
159  return impl < other.impl;
160  }
162 
165 public:
167  bool is_null() const { return !impl; }
168 
170  void throw_if_null() const;
171 
173  float get_min_lod() const;
174 
176  float get_max_lod() const;
177 
179  float get_lod_bias() const;
180 
182  int get_base_level() const;
183 
185  int get_max_level() const;
186 
189 
192 
194  bool is_resident() const;
195 
198 
201 
206 
210  std::weak_ptr<Texture_Impl> get_impl() const;
212 
215 public:
218 
220  void set_min_lod(float min_lod);
221 
223  void set_max_lod(float max_lod);
224 
226  void set_lod_bias(float lod_bias);
227 
229  void set_base_level(int base_level);
230 
232  void set_max_level(int max_level);
233 
236 
239 
241  void set_max_anisotropy(float max_anisotropy);
242 
245 
248 
251 
254 
257 
260 
263 
267 
270 protected:
271  std::shared_ptr<Texture_Impl> impl;
272 
273  friend class Texture2DArray;
275 };
276 
277 }
278 
TextureCube to_texture_cube() const
Dynamic cast to TextureCube.
void set_max_lod(float max_lod)
Set the maximum level of detail texture parameter.
@ texture_1d
Definition: texture.h:93
void set_min_lod(float min_lod)
Set the minimum level of detail texture parameter.
CompareFunction get_compare_function() const
Get the texture compare function.
1D texture array object class.
Definition: texture_1d_array.h:42
int get_max_level() const
Get the texture max level.
void set_max_anisotropy(float max_anisotropy)
Set the maximum degree of anisotropy.
@ comparemode_compare_r_to_texture
Definition: texture.h:87
TextureWrapMode
Texture coordinate wrapping modes.
Definition: texture.h:66
Texture object class.
Definition: texture.h:104
Texture2DArray to_texture_2d_array() const
Dynamic cast to Texture2DArray.
2D texture cube object class.
Definition: texture_cube.h:53
TextureDimensions
Texture dimensions.
Definition: texture.h:92
Resource manager.
Definition: resource_manager.h:45
@ filter_nearest_mipmap_nearest
Definition: texture.h:77
Texture1D to_texture_1d() const
Dynamic cast to Texture1D.
TextureFilter
Texture filters.
Definition: texture.h:74
void throw_if_null() const
Throw an exception if this object is invalid.
Texture1DArray to_texture_1d_array() const
Dynamic cast to Texture1DArray.
2D texture cube array object class.
Definition: texture_cube_array.h:42
bool is_null() const
Returns true if this object is invalid.
Definition: texture.h:167
TextureFilter get_min_filter() const
Get the texture minification filter.
Image Import Description Class.
Definition: image_import_description.h:49
static Texture load(GraphicContext &gc, const std::string &id, const XMLResourceDocument &doc, const ImageImportDescription &import_desc=ImageImportDescription())
Loads a Texture from a XML resource definition.
void set_max_level(int max_level)
Sets the texture max level texture parameter.
bool operator<(const Texture &other) const
Less than operator.
Definition: texture.h:157
Texture2D to_texture_2d() const
Dynamic cast to Texture2D.
Texture(TextureProvider *provider)
Constructs a texture from a texture provider.
float get_max_lod() const
Get the maximum level of detail.
@ texture_2d_array
Definition: texture.h:96
2D texture object class.
Definition: texture_2d.h:42
std::weak_ptr< Texture_Impl > get_impl() const
Get the implementation weakptr.
Texture(GraphicContext &gc, PixelBufferSet pixelbuffer_set)
Constructs a texture as described in a pixelbuffer set.
@ wrap_clamp_to_edge
Definition: texture.h:67
@ filter_nearest
Definition: texture.h:75
@ filter_linear_mipmap_nearest
Definition: texture.h:79
void generate_mipmap()
Generate the mipmap.
TextureCompareMode
Texture compare modes.
Definition: texture.h:85
@ filter_linear
Definition: texture.h:76
@ texture_3d
Definition: texture.h:97
void set_base_level(int base_level)
Sets the texture base level texture parameter.
TextureCompareMode get_compare_mode() const
Get the texture compare mode.
@ filter_nearest_mipmap_linear
Definition: texture.h:78
std::shared_ptr< Texture_Impl > impl
Definition: texture.h:271
int get_base_level() const
Get the texture base level.
@ wrap_mirrored_repeat
Definition: texture.h:69
Interface to drawing graphics.
Definition: graphic_context.h:258
@ texture_cube_array
Definition: texture.h:99
Interface for implementing a Texture target.
Definition: texture_provider.h:51
bool operator==(const Texture &other) const
Equality operator.
Definition: texture.h:145
void set_texture_compare(TextureCompareMode mode, CompareFunction func)
Sets the texture compare mode and compare function texture parameters.
TextureCubeArray to_texture_cube_array() const
Dynamic cast to TextureCubeArray.
virtual ~Texture()
float get_lod_bias() const
Get the level of detail bias constant.
2D texture array object class.
Definition: texture_2d_array.h:44
Definition: clanapp.h:36
Texture(const std::shared_ptr< Texture_Impl > &impl)
Constructs a texture from an implementation.
TextureProvider * get_provider() const
Get Provider.
XML Resource Document.
Definition: xml_resource_document.h:49
static Resource< Texture > resource(GraphicContext &gc, const std::string &id, const ResourceManager &resources)
Retrieves a Texture resource from the resource manager.
@ texture_cube
Definition: texture.h:98
TextureFilter get_mag_filter() const
Get the texture magnification filter.
@ filter_linear_mipmap_linear
Definition: texture.h:80
1D texture object class.
Definition: texture_1d.h:42
CompareFunction
Compare functions.
Definition: graphic_context.h:93
@ texture_2d
Definition: texture.h:95
bool operator!=(const Texture &other) const
Inequality operator.
Definition: texture.h:151
Set of images that combined form a complete texture.
Definition: pixel_buffer_set.h:47
@ wrap_repeat
Definition: texture.h:68
float get_min_lod() const
Get the minimum level of detail.
@ texture_1d_array
Definition: texture.h:94
Resource proxy of a specific type.
Definition: resource.h:59
3D texture object class.
Definition: texture_3d.h:42
void set_min_filter(TextureFilter filter)
Set the minification filter.
void set_lod_bias(float lod_bias)
Sets the level of detail bias constant.
void set_mag_filter(TextureFilter filter)
Set the magnification filter.
Texture3D to_texture_3d() const
Dynamic cast to Texture3D.
bool is_resident() const
Returns true if texture is resident in texture memory.
Texture()
Constructs a null instance.
@ comparemode_none
Definition: texture.h:86