/usr/share/doc/opencl-clhpp-headers/html/classcl_1_1_event.html is in opencl-clhpp-headers-doc 2.0.10+git12-g5dd8bb9-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenCL C++ Bindings: cl::Event Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenCL C++ Bindings
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classcl_1_1_event.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classcl_1_1_event-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cl::Event Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class interface for cl_event.
<a href="classcl_1_1_event.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for cl::Event:</div>
<div class="dyncontent">
<div class="center">
<img src="classcl_1_1_event.png" usemap="#cl::Event_map" alt=""/>
<map id="cl::Event_map" name="cl::Event_map">
<area href="classcl_1_1detail_1_1_wrapper.html" alt="cl::detail::Wrapper< cl_event >" shape="rect" coords="0,0,185,24"/>
<area href="classcl_1_1_user_event.html" title="Class interface for user events (a subset of cl_event's). " alt="cl::UserEvent" shape="rect" coords="0,112,185,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a90e01689f7b394fc003d66c48a7f6f95"><td class="memItemLeft" align="right" valign="top"><a id="a90e01689f7b394fc003d66c48a7f6f95"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a90e01689f7b394fc003d66c48a7f6f95">Event</a> ()</td></tr>
<tr class="memdesc:a90e01689f7b394fc003d66c48a7f6f95"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - initializes to NULL. <br /></td></tr>
<tr class="separator:a90e01689f7b394fc003d66c48a7f6f95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b035b8ff20d92d0b42f2f0dc8657621"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a3b035b8ff20d92d0b42f2f0dc8657621">Event</a> (const cl_event &event, bool retainObject=false)</td></tr>
<tr class="memdesc:a3b035b8ff20d92d0b42f2f0dc8657621"><td class="mdescLeft"> </td><td class="mdescRight">Constructor from cl_event - takes ownership. <a href="#a3b035b8ff20d92d0b42f2f0dc8657621">More...</a><br /></td></tr>
<tr class="separator:a3b035b8ff20d92d0b42f2f0dc8657621"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b9f7abf39de587ee78d0b47699d5f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcl_1_1_event.html">Event</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#aa3b9f7abf39de587ee78d0b47699d5f6">operator=</a> (const cl_event &rhs)</td></tr>
<tr class="memdesc:aa3b9f7abf39de587ee78d0b47699d5f6"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from cl_event - takes ownership. <a href="#aa3b9f7abf39de587ee78d0b47699d5f6">More...</a><br /></td></tr>
<tr class="separator:aa3b9f7abf39de587ee78d0b47699d5f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ad1d3040fcb24188f1ac2cd73591252"><td class="memTemplParams" colspan="2"><a id="a4ad1d3040fcb24188f1ac2cd73591252"></a>
template<typename T > </td></tr>
<tr class="memitem:a4ad1d3040fcb24188f1ac2cd73591252"><td class="memTemplItemLeft" align="right" valign="top">cl_int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a4ad1d3040fcb24188f1ac2cd73591252">getInfo</a> (cl_event_info name, T *param) const</td></tr>
<tr class="memdesc:a4ad1d3040fcb24188f1ac2cd73591252"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for clGetEventInfo(). <br /></td></tr>
<tr class="separator:a4ad1d3040fcb24188f1ac2cd73591252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3a362e550fbfa5f18e679357f1cdba8"><td class="memTemplParams" colspan="2"><a id="ad3a362e550fbfa5f18e679357f1cdba8"></a>
template<cl_int name> </td></tr>
<tr class="memitem:ad3a362e550fbfa5f18e679357f1cdba8"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcl_1_1detail_1_1param__traits.html">detail::param_traits</a>< detail::cl_event_info, name >::param_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#ad3a362e550fbfa5f18e679357f1cdba8">getInfo</a> (cl_int *err=NULL) const</td></tr>
<tr class="memdesc:ad3a362e550fbfa5f18e679357f1cdba8"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for clGetEventInfo() that returns by value. <br /></td></tr>
<tr class="separator:ad3a362e550fbfa5f18e679357f1cdba8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f5ef317602809c4a99d6f244f758b5f"><td class="memTemplParams" colspan="2"><a id="a3f5ef317602809c4a99d6f244f758b5f"></a>
template<typename T > </td></tr>
<tr class="memitem:a3f5ef317602809c4a99d6f244f758b5f"><td class="memTemplItemLeft" align="right" valign="top">cl_int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a3f5ef317602809c4a99d6f244f758b5f">getProfilingInfo</a> (cl_profiling_info name, T *param) const</td></tr>
<tr class="memdesc:a3f5ef317602809c4a99d6f244f758b5f"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for clGetEventProfilingInfo(). <br /></td></tr>
<tr class="separator:a3f5ef317602809c4a99d6f244f758b5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab76c11fecb0af5a0972903ee0f644193"><td class="memTemplParams" colspan="2"><a id="ab76c11fecb0af5a0972903ee0f644193"></a>
template<cl_int name> </td></tr>
<tr class="memitem:ab76c11fecb0af5a0972903ee0f644193"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structcl_1_1detail_1_1param__traits.html">detail::param_traits</a>< detail::cl_profiling_info, name >::param_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#ab76c11fecb0af5a0972903ee0f644193">getProfilingInfo</a> (cl_int *err=NULL) const</td></tr>
<tr class="memdesc:ab76c11fecb0af5a0972903ee0f644193"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for clGetEventProfilingInfo() that returns by value. <br /></td></tr>
<tr class="separator:ab76c11fecb0af5a0972903ee0f644193"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51f83064c2024df649667071e81fb847"><td class="memItemLeft" align="right" valign="top">cl_int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a51f83064c2024df649667071e81fb847">wait</a> () const</td></tr>
<tr class="memdesc:a51f83064c2024df649667071e81fb847"><td class="mdescLeft"> </td><td class="mdescRight">Blocks the calling thread until this event completes. <a href="#a51f83064c2024df649667071e81fb847">More...</a><br /></td></tr>
<tr class="separator:a51f83064c2024df649667071e81fb847"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4730c3b113e65efcf88aea0c9da13f52"><td class="memItemLeft" align="right" valign="top">cl_int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#a4730c3b113e65efcf88aea0c9da13f52">setCallback</a> (cl_int type, void(CL_CALLBACK *pfn_notify)(cl_event, cl_int, void *), void *user_data=NULL)</td></tr>
<tr class="memdesc:a4730c3b113e65efcf88aea0c9da13f52"><td class="mdescLeft"> </td><td class="mdescRight">Registers a user callback function for a specific command execution status. <a href="#a4730c3b113e65efcf88aea0c9da13f52">More...</a><br /></td></tr>
<tr class="separator:a4730c3b113e65efcf88aea0c9da13f52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcl_1_1detail_1_1_wrapper"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcl_1_1detail_1_1_wrapper')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classcl_1_1detail_1_1_wrapper.html">cl::detail::Wrapper< cl_event ></a></td></tr>
<tr class="memitem:a98dce667e0f400f2ba15a8a8d65fdea0 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a98dce667e0f400f2ba15a8a8d65fdea0"></a>
 </td><td class="memItemRight" valign="bottom"><b>Wrapper</b> (const cl_type &obj, bool retainObject)</td></tr>
<tr class="separator:a98dce667e0f400f2ba15a8a8d65fdea0 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af91bafdf8593c34e0d0722cdd93010be inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="af91bafdf8593c34e0d0722cdd93010be"></a>
 </td><td class="memItemRight" valign="bottom"><b>Wrapper</b> (const <a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > &rhs)</td></tr>
<tr class="separator:af91bafdf8593c34e0d0722cdd93010be inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a115618e2baf10ec5c09513394d985ea6 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a115618e2baf10ec5c09513394d985ea6"></a>
 </td><td class="memItemRight" valign="bottom"><b>Wrapper</b> (<a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > &&rhs) CL_HPP_NOEXCEPT_</td></tr>
<tr class="separator:a115618e2baf10ec5c09513394d985ea6 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a044bc05bb3eb90345cb9cf574b95a98f inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a044bc05bb3eb90345cb9cf574b95a98f"></a>
<a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > &rhs)</td></tr>
<tr class="separator:a044bc05bb3eb90345cb9cf574b95a98f inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d10265f9935f18fed55abe2560cd199 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a2d10265f9935f18fed55abe2560cd199"></a>
<a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > &&rhs)</td></tr>
<tr class="separator:a2d10265f9935f18fed55abe2560cd199 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47164ab536bdd1bdc4b9766354b5a982 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a47164ab536bdd1bdc4b9766354b5a982"></a>
<a class="el" href="classcl_1_1detail_1_1_wrapper.html">Wrapper</a>< cl_type > & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const cl_type &rhs)</td></tr>
<tr class="separator:a47164ab536bdd1bdc4b9766354b5a982 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89adf70432169d0b0a82bc6696a9aad1 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a89adf70432169d0b0a82bc6696a9aad1"></a>
const cl_type & </td><td class="memItemRight" valign="bottom"><b>operator()</b> () const</td></tr>
<tr class="separator:a89adf70432169d0b0a82bc6696a9aad1 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5aa32c6d3304d4ee9fb63491a72b0d58 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a5aa32c6d3304d4ee9fb63491a72b0d58"></a>
cl_type & </td><td class="memItemRight" valign="bottom"><b>operator()</b> ()</td></tr>
<tr class="separator:a5aa32c6d3304d4ee9fb63491a72b0d58 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b785e6bbf238183338a22800a6fe1d1 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a1b785e6bbf238183338a22800a6fe1d1"></a>
const cl_type </td><td class="memItemRight" valign="bottom"><b>get</b> () const</td></tr>
<tr class="separator:a1b785e6bbf238183338a22800a6fe1d1 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e9571071a0b51bb2fada511a1ebc964 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a4e9571071a0b51bb2fada511a1ebc964"></a>
cl_type </td><td class="memItemRight" valign="bottom"><b>get</b> ()</td></tr>
<tr class="separator:a4e9571071a0b51bb2fada511a1ebc964 inherit pub_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae84b90e930f72c1019435dd7cefa2fbd"><td class="memItemLeft" align="right" valign="top">static cl_int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcl_1_1_event.html#ae84b90e930f72c1019435dd7cefa2fbd">waitForEvents</a> (const vector< <a class="el" href="classcl_1_1_event.html">Event</a> > &events)</td></tr>
<tr class="memdesc:ae84b90e930f72c1019435dd7cefa2fbd"><td class="mdescLeft"> </td><td class="mdescRight">Blocks the calling thread until every event specified is complete. <a href="#ae84b90e930f72c1019435dd7cefa2fbd">More...</a><br /></td></tr>
<tr class="separator:ae84b90e930f72c1019435dd7cefa2fbd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classcl_1_1detail_1_1_wrapper"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classcl_1_1detail_1_1_wrapper')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classcl_1_1detail_1_1_wrapper.html">cl::detail::Wrapper< cl_event ></a></td></tr>
<tr class="memitem:a83841267bac5ad4411ec8935f78315d8 inherit pub_types_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a83841267bac5ad4411ec8935f78315d8"></a>
typedef cl_event </td><td class="memItemRight" valign="bottom"><b>cl_type</b></td></tr>
<tr class="separator:a83841267bac5ad4411ec8935f78315d8 inherit pub_types_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classcl_1_1detail_1_1_wrapper"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcl_1_1detail_1_1_wrapper')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classcl_1_1detail_1_1_wrapper.html">cl::detail::Wrapper< cl_event ></a></td></tr>
<tr class="memitem:adfdff8a6c98ca62fedc6a9ffced47a06 inherit pro_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="adfdff8a6c98ca62fedc6a9ffced47a06"></a>
cl_int </td><td class="memItemRight" valign="bottom"><b>retain</b> () const</td></tr>
<tr class="separator:adfdff8a6c98ca62fedc6a9ffced47a06 inherit pro_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a207374e201c6c33c01bdc7ee09e92d76 inherit pro_methods_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a207374e201c6c33c01bdc7ee09e92d76"></a>
cl_int </td><td class="memItemRight" valign="bottom"><b>release</b> () const</td></tr>
<tr class="separator:a207374e201c6c33c01bdc7ee09e92d76 inherit pro_methods_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classcl_1_1detail_1_1_wrapper"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classcl_1_1detail_1_1_wrapper')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classcl_1_1detail_1_1_wrapper.html">cl::detail::Wrapper< cl_event ></a></td></tr>
<tr class="memitem:a1292547dd0c591aa972e25b793481583 inherit pro_attribs_classcl_1_1detail_1_1_wrapper"><td class="memItemLeft" align="right" valign="top"><a id="a1292547dd0c591aa972e25b793481583"></a>
cl_type </td><td class="memItemRight" valign="bottom"><b>object_</b></td></tr>
<tr class="separator:a1292547dd0c591aa972e25b793481583 inherit pro_attribs_classcl_1_1detail_1_1_wrapper"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class interface for cl_event. </p>
<dl class="section note"><dt>Note</dt><dd>Copies of these objects are shallow, meaning that the copy will refer to the same underlying cl_event as the original. For details, see clRetainEvent() and clReleaseEvent().</dd></dl>
<dl class="section see"><dt>See also</dt><dd>cl_event </dd></dl>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l02978">2978</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a3b035b8ff20d92d0b42f2f0dc8657621"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b035b8ff20d92d0b42f2f0dc8657621">◆ </a></span>Event()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cl::Event::Event </td>
<td>(</td>
<td class="paramtype">const cl_event & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>retainObject</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor from cl_event - takes ownership. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">retainObject</td><td>will cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. This effectively transfers ownership of a refcount on the cl_event into the new <a class="el" href="classcl_1_1_event.html" title="Class interface for cl_event. ">Event</a> object. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l02992">2992</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa3b9f7abf39de587ee78d0b47699d5f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b9f7abf39de587ee78d0b47699d5f6">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcl_1_1_event.html">Event</a>& cl::Event::operator= </td>
<td>(</td>
<td class="paramtype">const cl_event & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator from cl_event - takes ownership. </p>
<p>This effectively transfers ownership of a refcount on the rhs and calls clReleaseEvent() on the value previously held by this instance. </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03000">3000</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<a id="a4730c3b113e65efcf88aea0c9da13f52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4730c3b113e65efcf88aea0c9da13f52">◆ </a></span>setCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cl_int cl::Event::setCallback </td>
<td>(</td>
<td class="paramtype">cl_int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(CL_CALLBACK *pfn_notify)(cl_event, cl_int, void *) </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>user_data</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a user callback function for a specific command execution status. </p>
<p>Wraps clSetEventCallback(). </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03068">3068</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<a id="a51f83064c2024df649667071e81fb847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51f83064c2024df649667071e81fb847">◆ </a></span>wait()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cl_int cl::Event::wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks the calling thread until this event completes. </p>
<p>Wraps clWaitForEvents(). </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03056">3056</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<a id="ae84b90e930f72c1019435dd7cefa2fbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae84b90e930f72c1019435dd7cefa2fbd">◆ </a></span>waitForEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static cl_int cl::Event::waitForEvents </td>
<td>(</td>
<td class="paramtype">const vector< <a class="el" href="classcl_1_1_event.html">Event</a> > & </td>
<td class="paramname"><em>events</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks the calling thread until every event specified is complete. </p>
<p>Wraps clWaitForEvents(). </p>
<p class="definition">Definition at line <a class="el" href="cl2_8hpp_source.html#l03088">3088</a> of file <a class="el" href="cl2_8hpp_source.html">cl2.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cl2_8hpp_source.html">cl2.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacecl.html">cl</a></li><li class="navelem"><a class="el" href="classcl_1_1_event.html">Event</a></li>
<li class="footer">Generated on Thu Jan 25 2018 01:39:34 for OpenCL C++ Bindings by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|