| <?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>clGetKernelSubGroupInfo</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> |
| <meta name="keywords" content="clGetKernelSubGroupInfo" /> |
| </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="clGetKernelSubGroupInfo"></a> |
| <h1> |
| clGetKernelSubGroupInfo |
| </h1> |
| <p> |
| Returns information about the kernel object. |
| </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">clGetKernelSubGroupInfo</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_sub_group_info" target="pagedisplay">cl_kernel_sub_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">input_value_size</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">*input_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</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">clGetKernelSubGroupInfo</code> is described in the table |
| below. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> <code class="varname">input_value_size</code> </span> |
| </dt> |
| <dd> |
| <p> |
| Specifies the size in bytes of memory pointed to by |
| <code class="varname">input_value</code>. This |
| size must be == size of input type as described in table below. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> <code class="varname">input_value</code> </span> |
| </dt> |
| <dd> |
| <p> |
| A pointer to memory where the appropriate parameterization of the query is passed from. |
| If <code class="varname">input_value</code> is NULL, it is ignored. |
| </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> |
| </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> |
| <div class="informaltable"> |
| <table border="1"> |
| <colgroup> |
| <col align="left" class="col1" /> |
| <col align="left" class="col2" /> |
| <col align="left" class="col3" /> |
| <col /> |
| </colgroup> |
| <thead> |
| <tr> |
| <th align="left">cl_kernel_sub_group_info</th> |
| <th align="left">Input Type</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_MAX_SUB_- |
| GROUP_SIZE_FOR_NDRANGE</code> |
| </td> |
| <td align="left">size_t *</td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| <p> |
| Returns the maximum sub-group size |
| for this kernel. All subgroups must be |
| the same size, while the last sub-group |
| in any work-group (i.e. the sub-group |
| with the maximum index) could be the |
| same or smaller size. |
| </p> |
| |
| <p> |
| The <code class="varname">input_value</code> must be an array of |
| <span class="type">size_t</span> values corresponding to the |
| local work size parameter of the |
| intended dispatch. The number of |
| dimensions in the ND-range will be |
| inferred from the value specified for |
| <code class="varname">input_value_size</code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_SUB_GROUP_- |
| COUNT_FOR_NDRANGE</code> |
| </td> |
| <td align="left">size_t *</td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| <p> |
| Returns the number of sub-groups that |
| will be present in each work-group for |
| a given local work size. All workgroups, |
| apart from the last work-group |
| in each dimension in the presence of |
| non-uniform work-group sizes, will |
| have the same number of subgroups. |
| </p> |
| |
| <p> |
| The <code class="varname">input_value</code> must be an array of |
| <span class="type">size_t</span> values corresponding to the |
| local work size parameter of the |
| intended dispatch. The number of |
| dimensions in the ND-range will be |
| inferred from the value specified for |
| <code class="varname">input_value_size</code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_LOCAL_SIZE_ |
| FOR_SUB_GROUP_COUNT</code> |
| </td> |
| <td align="left">size_t</td> |
| <td align="left">size_t []</td> |
| <td align="left"> |
| <p> |
| Returns the local size that will |
| generate the requested number of sub- |
| groups for the kernel. The output array |
| must be an array of <code class="code">size_t</code> values |
| corresponding to the local size |
| parameter. Any returned work-group |
| will have one dimension. Other |
| dimensions inferred from the value |
| specified for <code class="varname">param_value_size</code> |
| will be filled with the value 1. The |
| returned value will produce an exact |
| number of sub-groups and result in no |
| partial groups for an executing kernel |
| except in the case where the last work- |
| group in a dimension has a size |
| different from that of the other groups. |
| If no work-group size can |
| accommodate the requested number of |
| sub-groups, 0 will be returned in each |
| element of the return array. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_MAX_NUM_SUB_GROUPS</code> |
| </td> |
| <td align="left">ignored</td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| This provides a mechanism for the |
| application to query the maximum number |
| of sub-groups that may make up each |
| work-group to execute a kernel on a |
| specific device given by device. The |
| OpenCL implementation uses the resource |
| requirements of the kernel (register usage |
| etc.) to determine what this work-group |
| size should be. The returned value may be |
| used to compute a work-group size to |
| enqueue the kernel with to give a round |
| number of sub-groups for an enqueue. |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_COMPILE_NUM_SUB_GROUPS</code> |
| </td> |
| <td align="left">ignored</td> |
| <td align="left">size_t</td> |
| <td align="left"> |
| Returns the number of sub-groups |
| specified in the kernel source or IL. If the |
| sub-group count is not specified using the |
| above attribute then 0 is returned. |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </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_SUB_GROUP_SIZE_FOR_NDRANGE</code> |
| and the size in bytes specified by |
| <code class="varname">input_value_size</code> is not valid |
| or if <code class="varname">input_value</code> is NULL. |
| </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#page=236" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| </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> |
