display_target.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 */
28 
29 
30 #pragma once
31 
32 #include "api_display.h"
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class DisplayTargetProvider;
41 class DisplayTarget_Impl;
42 
44 class CL_API_DISPLAY DisplayTarget
45 {
48 
49 public:
54 
55  virtual ~DisplayTarget();
56 
60 
61 public:
63  DisplayTargetProvider *get_provider();
64 
66  bool is_null() const { return !impl; }
67 
69  void throw_if_null() const;
70 
74 
75 public:
77  void set_current();
78 
82 
83 public:
85  DisplayTarget();
86 
87 private:
88 
92  DisplayTarget(const std::weak_ptr<DisplayTarget_Impl> impl);
93 
94  std::shared_ptr<DisplayTarget_Impl> impl;
95 
96  friend class DisplayTarget_Impl;
98 };
99 
100 }
101 
bool is_null() const
Returns true if this object is invalid.
Definition: display_target.h:66
Display target for clanDisplay.
Definition: display_target.h:44
Interface for implementing a DisplayTarget target.
Definition: display_target_provider.h:44