display_target.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 DisplayTargetProvider;
40 class DisplayTarget_Impl;
41
43 class DisplayTarget
44 {
47
48 public:
52 DisplayTarget(DisplayTargetProvider *provider);
53
54 virtual ~DisplayTarget();
55
59
60 public:
62 DisplayTargetProvider *get_provider();
63
65 bool is_null() const { return !impl; }
66
68 void throw_if_null() const;
69
73
74 public:
76 void set_current();
77
81
82 private:
83
85 DisplayTarget();
86
90 DisplayTarget(const std::weak_ptr<DisplayTarget_Impl> impl);
91
92 std::shared_ptr<DisplayTarget_Impl> impl;
93
94 friend class DisplayTarget_Impl;
96 };
97
98 }
99
clan
Definition: clanapp.h:35
clan::DisplayTarget::get_provider
DisplayTargetProvider * get_provider()
Returns the provider for the display target.
clan::DisplayTarget::DisplayTarget_Impl
friend class DisplayTarget_Impl
Definition: display_target.h:94
clan::DisplayTarget::~DisplayTarget
virtual ~DisplayTarget()
clan::DisplayTarget::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::DisplayTarget::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: display_target.h:65
clan::DisplayTarget
Display target for clanDisplay.
Definition: display_target.h:43
clan::DisplayTarget::set_current
void set_current()
Set this display target to be the current target.
clan::DisplayTargetProvider
Interface for implementing a DisplayTarget target.
Definition: display_target_provider.h:43