subtexture.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 */
28
29
30 #pragma once
31
32 #include <memory>
33
34 namespace clan
35 {
38
39 class Size;
40 class Rect;
41 class Texture2D;
42 class Subtexture_Impl;
43
45 class Subtexture
46 {
49 public:
51 Subtexture();
52
57 Subtexture(Texture2D texture, const Rect &geometry);
58
59 ~Subtexture();
60
64 public:
66 bool is_null() const { return !impl; }
67
69 void throw_if_null() const;
70
72 Texture2D get_texture();
73
75 Rect get_geometry() const;
76
80 public:
81
85 private:
86 std::shared_ptr<Subtexture_Impl> impl;
88 };
89
90 }
91
clan::Subtexture::~Subtexture
~Subtexture()
clan
Definition: clanapp.h:35
clan::Subtexture
Sub-texture description.
Definition: subtexture.h:45
clan::Subtexture::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: subtexture.h:66
clan::Rect
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:470
clan::Texture2D
2D texture object class.
Definition: texture_2d.h:41
clan::Subtexture::Subtexture
Subtexture()
Constructs a null instance.
clan::Subtexture::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::Subtexture::get_geometry
Rect get_geometry() const
Returns the part of the texture used by this object.
clan::Subtexture::get_texture
Texture2D get_texture()
Returns the texture.