0.8.2 API documentation
texture.hpp
Go to the documentation of this file.
1 
4 #pragma once
5 
6 #include "image.hpp"
7 #include "target.hpp"
8 #include "levels.hpp"
9 #include <array>
10 
11 namespace gli
12 {
14  class texture
15  {
16  public:
17  typedef size_t size_type;
18  typedef gli::target target_type;
19  typedef gli::format format_type;
20  typedef gli::swizzles swizzles_type;
21  typedef storage_linear storage_type;
22  typedef storage_type::data_type data_type;
23  typedef storage_type::extent_type extent_type;
24 
26  texture();
27 
36  texture(
37  target_type Target,
38  format_type Format,
39  extent_type const& Extent,
40  size_type Layers,
41  size_type Faces,
42  size_type Levels,
43  swizzles_type const& Swizzles = swizzles_type(SWIZZLE_RED, SWIZZLE_GREEN, SWIZZLE_BLUE, SWIZZLE_ALPHA));
44 
50  texture(
51  texture const& Texture,
52  target_type Target,
53  format_type Format,
54  size_type BaseLayer, size_type MaxLayer,
55  size_type BaseFace, size_type MaxFace,
56  size_type BaseLevel, size_type MaxLevel,
57  swizzles_type const& Swizzles = swizzles_type(SWIZZLE_RED, SWIZZLE_GREEN, SWIZZLE_BLUE, SWIZZLE_ALPHA));
58 
62  texture(
63  texture const& Texture,
64  target_type Target,
65  format_type Format,
66  swizzles_type const& Swizzles = swizzles_type(SWIZZLE_RED, SWIZZLE_GREEN, SWIZZLE_BLUE, SWIZZLE_ALPHA));
67 
68  virtual ~texture(){}
69 
71  bool empty() const;
72 
74  target_type target() const{return this->Target;}
75 
77  format_type format() const;
78 
79  swizzles_type swizzles() const;
80 
82  size_type base_layer() const;
83 
85  size_type max_layer() const;
86 
88  size_type layers() const;
89 
91  size_type base_face() const;
92 
94  size_type max_face() const;
95 
97  size_type faces() const;
98 
100  size_type base_level() const;
101 
103  size_type max_level() const;
104 
106  size_type levels() const;
107 
109  extent_type extent(size_type Level = 0) const;
110 
112  size_type size() const;
113 
116  template <typename genType>
117  size_type size() const;
118 
120  size_type size(size_type Level) const;
121 
124  template <typename gen_type>
125  size_type size(size_type Level) const;
126 
128  void* data();
129 
131  template <typename gen_type>
132  gen_type* data();
133 
135  void const* data() const;
136 
138  template <typename gen_type>
139  gen_type const* data() const;
140 
142  void* data(size_type Layer, size_type Face, size_type Level);
143 
145  void const* const data(size_type Layer, size_type Face, size_type Level) const;
146 
148  template <typename gen_type>
149  gen_type* data(size_type Layer, size_type Face, size_type Level);
150 
152  template <typename gen_type>
153  gen_type const* const data(size_type Layer, size_type Face, size_type Level) const;
154 
156  void clear();
157 
160  template <typename gen_type>
161  void clear(gen_type const& Texel);
162 
164  template <typename gen_type>
165  void clear(size_type Layer, size_type Face, size_type Level, gen_type const& BlockData);
166 
168  template <typename gen_type>
169  void clear(size_type Layer, size_type Face, size_type Level, extent_type const& TexelOffset, extent_type const& TexelExtent, gen_type const& BlockData);
170 
172  void copy(
173  texture const& TextureSrc,
174  size_t LayerSrc, size_t FaceSrc, size_t LevelSrc,
175  size_t LayerDst, size_t FaceDst, size_t LevelDst);
176 
178  void copy(
179  texture const& TextureSrc,
180  size_t LayerSrc, size_t FaceSrc, size_t LevelSrc, extent_type const& OffsetSrc,
181  size_t LayerDst, size_t FaceDst, size_t LevelDst, extent_type const& OffsetDst,
182  extent_type const& Extent);
183 
185  template <typename gen_type>
186  void swizzle(gli::swizzles const& Swizzles);
187 
189  template <typename gen_type>
190  gen_type load(extent_type const & TexelCoord, size_type Layer, size_type Face, size_type Level) const;
191 
193  template <typename gen_type>
194  void store(extent_type const& TexelCoord, size_type Layer, size_type Face, size_type Level, gen_type const& Texel);
195 
196  protected:
197  std::shared_ptr<storage_type> Storage;
198  target_type Target;
199  format_type Format;
200  size_type BaseLayer;
201  size_type MaxLayer;
202  size_type BaseFace;
203  size_type MaxFace;
204  size_type BaseLevel;
205  size_type MaxLevel;
206  swizzles_type Swizzles;
207 
208  // Pre compute at texture instance creation some information for faster access to texels
209  struct cache
210  {
211  public:
212  enum ctor
213  {
214  DEFAULT
215  };
216 
217  explicit cache(ctor)
218  {}
219 
220  cache
221  (
222  storage_type& Storage,
223  format_type Format,
224  size_type BaseLayer, size_type Layers,
225  size_type BaseFace, size_type MaxFace,
226  size_type BaseLevel, size_type MaxLevel
227  )
228  : Faces(MaxFace - BaseFace + 1)
229  , Levels(MaxLevel - BaseLevel + 1)
230  {
231  GLI_ASSERT(static_cast<size_t>(gli::levels(Storage.extent(0))) < this->ImageMemorySize.size());
232 
233  this->BaseAddresses.resize(Layers * this->Faces * this->Levels);
234 
235  for(size_type Layer = 0; Layer < Layers; ++Layer)
236  for(size_type Face = 0; Face < this->Faces; ++Face)
237  for(size_type Level = 0; Level < this->Levels; ++Level)
238  {
239  size_type const Index = index_cache(Layer, Face, Level);
240  this->BaseAddresses[Index] = Storage.data() + Storage.base_offset(
241  BaseLayer + Layer, BaseFace + Face, BaseLevel + Level);
242  }
243 
244  for(size_type Level = 0; Level < this->Levels; ++Level)
245  {
246  extent_type const& SrcExtent = Storage.extent(BaseLevel + Level);
247  extent_type const& DstExtent = SrcExtent * block_extent(Format) / Storage.block_extent();
248 
249  this->ImageExtent[Level] = glm::max(DstExtent, extent_type(1));
250  this->ImageMemorySize[Level] = Storage.level_size(BaseLevel + Level);
251  }
252 
253  this->GlobalMemorySize = Storage.layer_size(BaseFace, MaxFace, BaseLevel, MaxLevel) * Layers;
254  }
255 
256  // Base addresses of each images of a texture.
257  data_type* get_base_address(size_type Layer, size_type Face, size_type Level) const
258  {
259  return this->BaseAddresses[index_cache(Layer, Face, Level)];
260  }
261 
262  // In texels
263  extent_type get_extent(size_type Level) const
264  {
265  return this->ImageExtent[Level];
266  };
267 
268  // In bytes
269  size_type get_memory_size(size_type Level) const
270  {
271  return this->ImageMemorySize[Level];
272  };
273 
274  // In bytes
275  size_type get_memory_size() const
276  {
277  return this->GlobalMemorySize;
278  };
279 
280  private:
281  size_type index_cache(size_type Layer, size_type Face, size_type Level) const
282  {
283  return ((Layer * this->Faces) + Face) * this->Levels + Level;
284  }
285 
286  size_type Faces;
287  size_type Levels;
288  std::vector<data_type*> BaseAddresses;
289  std::array<extent_type, 16> ImageExtent;
290  std::array<size_type, 16> ImageMemorySize;
291  size_type GlobalMemorySize;
292  } Cache;
293  };
294 }//namespace gli
295 
296 #include "./core/texture.inl"
297 
gli::block_extent
ivec3 block_extent(format Format)
Return the dimensions in texels of the block for a format.
gli::texture::swizzle
void swizzle(gli::swizzles const &Swizzles)
Reorder the component in texture memory.
gli::texture::target
target_type target() const
Return the target of a texture instance.
Definition: texture.hpp:74
gli::texture::levels
size_type levels() const
Return max_level() - base_level() + 1.
gli::texture::load
gen_type load(extent_type const &TexelCoord, size_type Layer, size_type Face, size_type Level) const
Fetch a texel from a texture. The texture format must be uncompressed.
gli::format
format
Texture data format.
Definition: format.hpp:12
gli::texture::store
void store(extent_type const &TexelCoord, size_type Layer, size_type Face, size_type Level, gen_type const &Texel)
Write a texel to a texture. The texture format must be uncompressed.
gli::texture::base_layer
size_type base_layer() const
Return the base layer of the texture instance, effectively a memory offset in the actual texture stor...
gli::texture::max_layer
size_type max_layer() const
Return the max layer of the texture instance, effectively a memory offset to the beginning of the las...
gli::texture::empty
bool empty() const
Return whether the texture instance is empty, no storage_type or description have been assigned to th...
gli::texture::texture
texture()
Create an empty texture instance.
levels.hpp
Include to compute the number of mipmaps levels necessary to create a mipmap complete texture...
target.hpp
Include to use the target enum and query properties of targets.
gli::texture::max_face
size_type max_face() const
Return the max face of the texture instance, effectively a memory offset to the beginning of the last...
gli::texture::format
format_type format() const
Return the texture instance format.
gli::texture
Genetic texture class. It can support any target.
Definition: texture.hpp:14
gli::texture::data
void * data()
Return a pointer to the beginning of the texture instance data.
gli::texture::max_level
size_type max_level() const
Return the max level of the texture instance, effectively a memory offset to the beginning of the las...
image.hpp
Include to use images, a representation of a single texture level.
gli::texture::size
size_type size() const
Return the memory size of a texture instance storage_type in bytes.
gli::target
target
Texture target: type/shape of the texture storage_linear.
Definition: target.hpp:9
gli::texture::layers
size_type layers() const
Return max_layer() - base_layer() + 1.
gli::texture::faces
size_type faces() const
Return max_face() - base_face() + 1.
gli
Namespace where all the classes and functions provided by GLI are exposed.
Definition: clear.hpp:6
gli::texture::copy
void copy(texture const &TextureSrc, size_t LayerSrc, size_t FaceSrc, size_t LevelSrc, size_t LayerDst, size_t FaceDst, size_t LevelDst)
Copy a specific image of a texture.
gli::texture::extent
extent_type extent(size_type Level=0) const
Return the size of a texture instance: width, height and depth.
gli::texture::base_face
size_type base_face() const
Return the base face of the texture instance, effectively a memory offset in the actual texture stora...
gli::texture::base_level
size_type base_level() const
Return the base level of the texture instance, effectively a memory offset in the actual texture stor...
gli::texture::clear
void clear()
Clear the entire texture storage_linear with zeros.
gli::levels
T levels(vecType< T, P > const &Extent)
Compute the number of mipmaps levels necessary to create a mipmap complete texture.
Generated by   doxygen 1.8.10