subtexture.h Source File - ClanLib SDK
Description: subtexture.h Source File

subtexture.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32
33namespace clan
34{
37
38 class Size;
39 class Rect;
40 class Texture2D;
41 class Subtexture_Impl;
42
44 class Subtexture
45 {
46 public:
48 Subtexture();
49
54 Subtexture(Texture2D texture, const Rect &geometry);
55 ~Subtexture();
56
58 bool is_null() const { return !impl; }
59 explicit operator bool() const { return bool(impl); }
60
62 void throw_if_null() const;
63
65 Texture2D get_texture();
66
68 Rect get_geometry() const;
69
70 private:
71 std::shared_ptr<Subtexture_Impl> impl;
72 };
73
75}
clan::Rect
2D (left,top,right,bottom) rectangle structure - Integer
Definition rect.h:446
clan::Size
2D (width,height) size structure - Integer
Definition size.h:176
clan::Subtexture::get_geometry
Rect get_geometry() const
Returns the part of the texture used by this object.
clan::Subtexture::~Subtexture
~Subtexture()
clan::Subtexture::is_null
bool is_null() const
Returns true if this object is invalid.
Definition subtexture.h:58
clan::Subtexture::Subtexture
Subtexture()
Constructs a null instance.
clan::Subtexture::Subtexture
Subtexture(Texture2D texture, const Rect &geometry)
Constructs a Subtexture.
clan::Subtexture::get_texture
Texture2D get_texture()
Returns the texture.
clan::Subtexture::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::Texture2D
2D texture object class.
Definition texture_2d.h:41
clan::ShaderType::geometry
@ geometry
Definition shader_object.h:52
clan
Definition clanapp.h:36