Google Git Google Git
Sign in
skia/external/github.com/KhronosGroup/OpenCL-Registry/3add82d5a48fe793692251ef3fcbc25129e279fa/./sdk/2.1/docs/man/xhtml/clGetEventProfilingInfo.html
blob: c98a9c81d0f7add09a9a818b2ebb6df3bb01eaf0 [file]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>clGetEventProfilingInfo</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clGetEventProfilingInfo" />
</head>
<body>
<div class="refentry">
<a id="id-1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clGetEventProfilingInfo"></a>
<h1>
clGetEventProfilingInfo
</h1>
<p>
Returns profiling information for the command associated with event if profiling is enabled.
</p>
</div>
<div class="refsynopsisdiv">
<h2></h2>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
<a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
<strong class="fsfunc">clGetEventProfilingInfo</strong>
(</code>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">event</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_profiling_info" target="pagedisplay">cl_profiling_info</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value_size_ret</var><code>)</code></td>
</tr>
</table>
</div>
</div>
<div class="refsect1">
<a id="parameters"></a>
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term"> <code class="varname">event</code> </span>
</dt>
<dd>
<p>Specifies the event object.</p>
</dd>
<dt>
<span class="term"> <code class="varname">param_name</code> </span>
</dt>
<dd>
<p>Specifies the profiling data to query. The list of supported
<code class="varname">param_name</code> types and the information returned in
<code class="varname">param_value</code> by <code class="function">clGetEventProfilingInfo</code>
is described in the table of parameter queries below.
</p>
</dd>
<dt>
<span class="term"> <code class="varname">param_value_size</code> </span>
</dt>
<dd>
<p>
Specifies the size in bytes of memory pointed to by
<code class="varname">param_value</code>. This size must be ≥ size of return
type as described in the table below.
</p>
</dd>
<dt>
<span class="term"> <code class="varname">param_value</code> </span>
</dt>
<dd>
<p>
A pointer to memory where the appropriate result being queried is returned.
if <code class="varname">param_value</code> is NULL, it is ignored.
</p>
</dd>
<dt>
<span class="term"> <code class="varname">param_value_size_ret</code> </span>
</dt>
<dd>
<p>
Returns the actual size in bytes of data copied to
<code class="varname">param_value</code>. If <code class="varname">param_value_size_ret</code>
is NULL, it is ignored.
</p>
</dd>
<dt></dt>
<dd>
<p>
The following is a table of <code class="function">clGetEventProfilingInfo</code>
parameter queries
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
<col align="left" class="col3" />
</colgroup>
<thead>
<tr>
<th align="left">cl_profiling_info</th>
<th align="left">Return Type</th>
<th align="left">Info. returned in <code class="varname">param_value</code></th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_PROFILING_COMMAND_QUEUED</code>
</td>
<td align="left">cl_ulong</td>
<td align="left">
A 64-bit value that describes the current device time counter in
nanoseconds when the command identified by <code class="varname">event</code>
is enqueued in a command-queue by the host.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_PROFILING_COMMAND_SUBMIT</code>
</td>
<td align="left">cl_ulong</td>
<td align="left">
A 64-bit value that describes the current device time counter in
nanoseconds when the command identified by <code class="varname">event</code>
that has been enqueued is submitted by the host to the device associated
with the command-queue.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_PROFILING_COMMAND_START</code>
</td>
<td align="left">cl_ulong</td>
<td align="left">
A 64-bit value that describes the current device time counter in
nanoseconds when the command identified by <code class="varname">event</code>
starts execution on the device.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_PROFILING_COMMAND_END</code>
</td>
<td align="left">cl_ulong</td>
<td align="left">
A 64-bit value that describes the current device time counter in
nanoseconds when the command identified by <code class="varname">event</code>
has finished execution on the device.
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_PROFILING_COMMAND_COMPLETE</code>
</td>
<td align="left">cl_ulong</td>
<td align="left">
A 64-bit value that describes the current device time counter in
nanoseconds when the command
identified by <code class="varname">event</code> and any child
commands enqueued by this command on the device have finished
execution.
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
The unsigned 64-bit values returned can be used to measure the time in nano-seconds
consumed by OpenCL commands.
</p>
<p>
OpenCL devices are required to correctly track time across changes in device frequency
and power states. The <code class="constant">CL_DEVICE_PROFILING_TIMER_RESOLUTION</code>
specifies the resolution of the timer i.e. the number of nanoseconds elapsed before
the timer is incremented.
</p>
<p>
Event objects can be used to capture profiling information that measure execution
time of a command. Profiling of OpenCL commands can be enabled either by using a
command-queue created with <code class="constant">CL_QUEUE_PROFILING_ENABLE</code>
flag set in <code class="varname">properties</code> argument to
<a class="citerefentry" href="clCreateCommandQueueWithProperties.html"><span class="citerefentry"><span class="refentrytitle">clCreateCommandQueueWithProperties</span></span></a>.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully
and the profiling information has been recorded. Otherwise, it returns one of the
following errors:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_PROFILING_INFO_NOT_AVAILABLE</span> if the
<code class="constant">CL_QUEUE_PROFILING_ENABLE</code> flag is not set for the command-queue,
if the execution status of the command identified by <code class="varname">event</code>
is not <code class="constant">CL_COMPLETE</code> or if <code class="varname">event</code>
refers to the
<a class="citerefentry" href="clEnqueueSVMFree.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueSVMFree</span></span></a>
command or is a user event object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code> is not
valid, or if size in bytes specified by <code class="varname">param_value_size</code>
is &lt; size of return type as described in the above table and
<code class="varname">param_value</code> is not NULL.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT</span> if <code class="varname">event</code> is a not a
valid event object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</li>
</ul>
</div>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
<a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#page=263" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="clCreateCommandQueueWithProperties.html"><span class="citerefentry"><span class="refentrytitle">clCreateCommandQueueWithProperties</span></span></a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
</div>
</body>
</html>