texture_2d_array.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_display.h"
34 #include "texture.h"
35 
36 namespace clan
37 {
40 
41 class Texture2D;
42 
44 class CL_API_DISPLAY Texture2DArray : public Texture
45 {
48 public:
51 
55  Texture2DArray(const std::shared_ptr<Texture_Impl> &impl) : Texture(impl) { }
56 
64  Texture2DArray(GraphicContext &context, int width, int height, int array_size, TextureFormat texture_format = tf_rgba8, int levels = 1);
65 
71  Texture2DArray(GraphicContext &context, const Size &size, int array_size, TextureFormat texture_format = tf_rgba8, int levels = 1);
73 
76 public:
78  int get_width() const;
79 
81  int get_height() const;
82 
84  Size get_size() const;
85 
87  int get_array_size() const;
88 
90  TextureWrapMode get_wrap_mode_s() const;
91 
93  TextureWrapMode get_wrap_mode_t() const;
95 
98 public:
105  void set_image(
106  GraphicContext &context,
107  int array_index,
108  const PixelBuffer &image,
109  int level = 0);
110 
117  void set_subimage(
118  GraphicContext &context,
119  int array_index,
120  int x,
121  int y,
122  const PixelBuffer &image,
123  const Rect &src_rect,
124  int level = 0);
125 
126  void set_subimage(
127  GraphicContext &context,
128  int array_index,
129  const Point &point,
130  const PixelBuffer &image,
131  const Rect &src_rect,
132  int level = 0);
133 
134  void set_wrap_mode(
135  TextureWrapMode wrap_s,
136  TextureWrapMode wrap_t);
137 
139  Texture2D create_2d_view(int array_index, TextureFormat texture_format, int min_level, int num_levels);
141 };
142 
143 }
144 
TextureWrapMode
Texture coordinate wrapping modes.
Definition: texture.h:66
Texture object class.
Definition: texture.h:104
Pixel data container.
Definition: pixel_buffer.h:69
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:453
2D texture object class.
Definition: texture_2d.h:42
TextureFormat
Texture format.
Definition: texture_format.h:41
Interface to drawing graphics.
Definition: graphic_context.h:257
2D (x,y) point structure - Integer
Definition: point.h:63
2D (width,height) size structure - Integer
Definition: size.h:157
Texture2DArray(const std::shared_ptr< Texture_Impl > &impl)
Constructs a texture from an implementation.
Definition: texture_2d_array.h:55
Definition: texture_format.h:44
2D texture array object class.
Definition: texture_2d_array.h:44