| <?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>clEnqueueNativeKernel</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clEnqueueNativeKernel" /> | |
| </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="clEnqueueNativeKernel"></a> | |
| <h1>clEnqueueNativeKernel</h1> | |
| <p> | |
| Enqueues a command to execute a native C/C++ function not compiled using the OpenCL compiler. | |
| </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"> | |
| clEnqueueNativeKernel | |
| </strong> | |
| (</code> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_command_queue</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">command_queue</var>, </td> | |
| </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">(CL_CALLBACK *user_func)(void *)</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">*args</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">cb_args</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_mem_objects</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*mem_list</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <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">**args_mem_loc</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_events_in_wait_list</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <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_wait_list</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <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><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"> command_queue </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A valid host command-queue. A native user | |
| function can only be executed on a command-queue created on a device | |
| that has <code class="constant">CL_EXEC_NATIVE_KERNEL</code> capability | |
| set in <code class="constant">CL_DEVICE_EXECUTION_CAPABILITIES</code> | |
| as specified in the table of OpenCL Device Queries for | |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> user_func </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a host-callable user function. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> args </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to the args list that <code class="varname">user_func</code> | |
| should be called with. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> cb_args </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| The size in bytes of the args list that <code class="varname">args</code> points to. | |
| </p> | |
| <p> | |
| The data pointed to by <code class="varname">args</code> and <code class="varname">cb_args</code> | |
| bytes in size will be copied and a pointer to this copied region will be | |
| passed to <code class="varname">user_func</code>. The copy needs to be done because | |
| the memory objects (<span class="type">cl_mem</span> values) that <code class="varname">args</code> | |
| may contain need to be modified and replaced by appropriate pointers to | |
| global memory. When <code class="function">clEnqueueNativeKernel</code> returns, | |
| the memory region pointed to by <code class="varname">args</code> can be reused by | |
| the application. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> num_mem_objects </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of buffer objects that are passed in <code class="varname">args</code>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> mem_list </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A list of valid buffer objects, | |
| if <code class="varname">num_mem_objects</code> > 0. The buffer | |
| object values specified in <code class="varname">mem_list</code> are | |
| memory object handles (<span class="type">cl_mem</span> values) returned by | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| or NULL. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> args_mem_loc </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to appropriate locations | |
| that <code class="varname">args</code> points to where memory object handles | |
| (<span class="type">cl_mem</span> values) are stored. Before the user function is | |
| executed, the memory object handles are replaced by pointers to global | |
| memory. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> | |
| <code class="varname">event_wait_list</code> and | |
| <code class="varname">num_events_in_wait_list</code> | |
| </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specify events that need | |
| to complete before this particular command can be executed. If | |
| <code class="varname">event_wait_list</code> is NULL, then this particular command does | |
| not wait on any event to complete. If <code class="varname">event_wait_list</code> | |
| is NULL, <code class="varname">num_events_in_wait_list</code> must be 0. If | |
| <code class="varname">event_wait_list</code> is not NULL, the list of events | |
| pointed to by <code class="varname">event_wait_list</code> must be valid | |
| and <code class="varname">num_events_in_wait_list</code> must be greater | |
| than 0. The events specified in <code class="varname">event_wait_list</code> | |
| act as synchronization points. The context associated with events in | |
| <code class="varname">event_wait_list</code> and <code class="varname">command_queue</code> must | |
| be the same. The memory associated with <code class="varname">event_wait_list</code> | |
| can be reused or freed after the function returns. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="notes"></a> | |
| <h2>Notes</h2> | |
| <p> | |
| The total number of read-only images specified as arguments to a kernel cannot exceed | |
| <code class="constant">CL_DEVICE_MAX_READ_IMAGE_ARGS</code>. Each image array argument to | |
| a kernel declared with the <code class="code">read_only</code> qualifier counts as one image. | |
| </p> | |
| <p> | |
| The total number of write-only images specified as arguments to a kernel cannot exceed | |
| <code class="constant">CL_DEVICE_MAX_WRITE_IMAGE_ARGS</code>. Each image array argument to | |
| a kernel declared with the <code class="code">write_only</code> qualifier counts as one image. | |
| </p> | |
| <p> | |
| The total number of read-write images specified | |
| as arguments to a kernel cannot exceed | |
| <code class="constant">CL_DEVICE_MAX_READ_WRITE_IMAGE_ARGS</code>. | |
| Each image array argument to a kernel | |
| declared with the <code class="code">read_write</code> qualifier | |
| counts as one image. | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| Returns <span class="errorname">CL_SUCCESS</span> if the user function execution instance | |
| was successfully queued. 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_INVALID_COMMAND_QUEUE</span> if <code class="varname">command_queue</code> | |
| is not a valid host command-queue. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if context associated with | |
| <code class="varname">command_queue</code> and events in <code class="varname">event_wait_list</code> | |
| are not the same. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">user_func</code> is NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">args</code> is a NULL | |
| value and <code class="varname">cb_args</code> > 0, or if <code class="varname">args</code> is a | |
| NULL value and <code class="varname">num_mem_objects</code> > 0. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">args</code> is not NULL | |
| and <code class="varname">cb_args</code> is 0. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">num_mem_objects</code> | |
| > 0 and <code class="varname">mem_list</code> or <code class="varname">args_mem_loc</code> are NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">num_mem_objects</code> = | |
| 0 and <code class="varname">mem_list</code> or <code class="varname">args_mem_loc</code> are not NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if the device associated with | |
| <code class="varname">command_queue</code> cannot execute the native kernel. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> if one or more memory objects | |
| specified in <code class="varname">mem_list</code> are not valid or are not buffer objects. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to queue the | |
| execution instance of <code class="varname">kernel</code> on the command-queue because of | |
| insufficient resources needed to execute the kernel. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MEM_OBJECT_ALLOCATION_FAILURE</span> if there is a failure | |
| to allocate memory for data store associated with buffer objects specified as | |
| arguments to <code class="varname">kernel</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT_WAIT_LIST</span> | |
| if <code class="varname">event_wait_list</code> is NULL and | |
| <code class="varname">num_events_in_wait_list</code> > 0, | |
| or <code class="varname">event_wait_list</code> is not NULL and | |
| <code class="varname">num_events_in_wait_list</code> is 0, or if event objects in | |
| <code class="varname">event_wait_list</code> are not valid events. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> | |
| if SVM pointers are passed as arguments to a kernel and the | |
| device does not support SVM or if system | |
| pointers are passed as arguments to a kernel | |
| and/or stored inside SVM allocations passed | |
| as kernel arguments and the device does not | |
| support fine grain system SVM allocations. | |
| </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=246" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>, | |
| <a class="citerefentry" href="clEnqueueNativeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNativeKernel</span></span></a>, | |
| <a class="citerefentry" href="clCreateCommandQueueWithProperties.html"><span class="citerefentry"><span class="refentrytitle">clCreateCommandQueueWithProperties</span></span></a>, | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>, | |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</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> |