compute_event.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_compute.h"
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class ComputeEvent_Impl;
41 
43 class CL_API_COMPUTE ComputeEvent
44 {
47 public:
49  ComputeEvent();
50 
51  ~ComputeEvent();
53 
56 public:
58  bool is_null() const { return !impl; }
59 
61  void throw_if_null() const;
63 
66 public:
67  void wait();
69 
72 private:
73  ComputeEvent(ComputeEvent_Impl *impl);
74 
75  std::shared_ptr<ComputeEvent_Impl> impl;
76 
77  friend class ComputeCommandQueue;
78  friend class ComputeCommandQueue_Impl;
80 };
81 
82 }
83 
Compute command queue.
Definition: compute_command_queue.h:50
Compute event object.
Definition: compute_event.h:43
bool is_null() const
Returns true if this object is invalid.
Definition: compute_event.h:58