| <?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>clGetKernelWorkGroupInfo</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> |
| <meta name="keywords" content="clGetKernelWorkGroupInfo" /> |
| </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="clGetKernelWorkGroupInfo"></a> |
| <h1> |
| clGetKernelWorkGroupInfo |
| </h1> |
| <p> |
| Returns information about the kernel object that may be specific to a device. |
| </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">clGetKernelWorkGroupInfo</strong> |
| (</code> |
| <td> |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_kernel</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">kernel</var> |
| , </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td> |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_device_id</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">device</var> |
| , </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td> |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_kernel_work_group_info" target="pagedisplay">cl_kernel_work_group_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"> kernel </code> </span> |
| </dt> |
| <dd> |
| <p> |
| Specifies the kernel object being queried. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> <code class="varname"> device </code> </span> |
| </dt> |
| <dd> |
| <p> |
| Identifies a specific device in the list of devices associated with |
| <code class="varname">kernel</code>. The list of devices is the list of devices in |
| the OpenCL context that is associated with <code class="varname">kernel</code>. If |
| the list of devices associated with <code class="varname">kernel</code> is a single |
| device, <code class="varname">device</code> can be a NULL value. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> <code class="varname"> param_name </code> </span> |
| </dt> |
| <dd> |
| <p> |
| Specifies the information 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">clGetKernelWorkGroupInfo</code> is 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 </code> </span> |
| </dt> |
| <dd> |
| <p> |
| Used to specify 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> |
| <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_kernel_work_group_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_KERNEL_GLOBAL_WORK_SIZE</code> |
| </td> |
| <td align="left">size_t[3]</td> |
| <td align="left"> |
| |
| This provides a mechanism for the application to query the maximum global |
| size that can be used to execute a kernel (i.e. <code class="varname">global_work_size</code> |
| argument to <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>) |
| on a custom device given by <code class="varname">device</code> or a built-in kernel on an OpenCL device |
| given by <code class="varname">device</code>. |
| |
| <p> |
| If <code class="varname">device</code> is not a custom device |
| or <code class="varname">kernel</code> is not a built-in kernel, |
| <code class="function">clGetKernelWorkGroupInfo</code> |
| returns the error <code class="constant">CL_INVALID_VALUE</code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_WORK_GROUP_SIZE</code> |
| </td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| <p> |
| This provides a mechanism for the application |
| to query the maximum work-group size |
| that can be used to execute the kernel on a |
| specific device given by <code class="varname">device</code>. The |
| OpenCL implementation uses the resource requirements of the kernel |
| (register usage etc.) to determine what this work-group size should be. |
| </p> |
| |
| <p> |
| As a result and unlike |
| <code class="constant">CL_DEVICE_MAX_WORK_GROUP_SIZE</code> |
| this value may vary from one kernel |
| to another as well as one device to |
| another. |
| </p> |
| |
| <p> |
| <code class="constant">CL_KERNEL_WORK_GROUP_SIZE</code> |
| will be less than or equal to |
| <code class="constant">CL_DEVICE_MAX_WORK_GROUP_SIZE</code> |
| for a given kernel object. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_COMPILE_- |
| WORK_GROUP_SIZE</code> |
| </td> |
| <td align="left">size_t[3]</td> |
| <td align="left"> |
| Returns the work-group size specified in |
| the kernel source or IL. |
| |
| If the work-group size is not specified in the kernel |
| source or IL, (0, 0, 0) is returned. |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_LOCAL_MEM_SIZE</code> |
| </td> |
| <td align="left">cl_ulong</td> |
| <td align="left"> |
| <p> |
| Returns the amount of local memory in bytes being |
| used by a kernel. This includes local memory that may |
| be needed by an implementation to execute the kernel, |
| variables declared inside the kernel with the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a> |
| address qualifier and local memory to |
| be allocated for arguments to the kernel |
| declared as pointers with the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a> |
| address qualifier and whose size is specified with |
| <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>. |
| </p> |
| |
| <p> |
| If the local memory size, for any pointer |
| argument to the kernel declared with the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a> |
| address qualifier, is not specified, its size is assumed |
| to be 0. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_PREFERRED_WORK_- |
| GROUP_SIZE_MULTIPLE</code> |
| </td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| Returns the preferred multiple of workgroup size for launch. This is |
| a performance hint. Specifying a workgroup size that is not a multiple |
| of the value returned by this query as the value of the local work size argument |
| to <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a> will |
| not fail to enqueue the kernel for execution unless the work-group size specified is |
| larger than the device maximum. |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_PRIVATE_MEM_SIZE</code> |
| </td> |
| <td align="left">cl_ulong</td> |
| <td align="left"> |
| Returns the minimum amount of private memory, in bytes, used by each work-item in the |
| kernel. This value may include any private memory needed by an implementation to |
| execute the kernel, including that used by the language built-ins and variable declared |
| inside the kernel with the |
| <a class="citerefentry" href="private.html"><span class="citerefentry"><span class="refentrytitle">__private</span></span></a> qualifier. |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </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> |
| </dl> |
| </div> |
| </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. 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_DEVICE</span> if <code class="varname">device</code> is |
| not in the list of devices associated with <code class="varname">kernel</code> or if |
| <code class="varname">device</code> is NULL but there is more than one device associated |
| with <code class="varname">kernel</code>. |
| </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 < size of return type as described in the table above and |
| <code class="varname">param_value</code> is not NULL. |
| </li> |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">param_name</code> is |
| <code class="constant">CL_KERNEL_GLOBAL_WORK_SIZE</code> and <code class="varname">device</code> |
| is not a custom device and <code class="varname">kernel</code> is not a built-in kernel. |
| </li> |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_KERNEL</span> if <code class="varname">kernel</code> is a not |
| a valid kernel 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#namedest=clGetKernelWorkGroupInfo" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| <a class="citerefentry" href="clCreateKernel.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernel</span></span></a>, |
| <a class="citerefentry" href="clCreateKernelsInProgram.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernelsInProgram</span></span></a>, |
| <a class="citerefentry" href="clReleaseKernel.html"><span class="citerefentry"><span class="refentrytitle">clReleaseKernel</span></span></a>, |
| <a class="citerefentry" href="clRetainKernel.html"><span class="citerefentry"><span class="refentrytitle">clRetainKernel</span></span></a>, |
| <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>, |
| <a class="citerefentry" href="clGetKernelInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelInfo</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> |