| <?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>clGetKernelArgInfo</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> |
| <meta name="keywords" content="clGetKernelArgInfo" /> |
| </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="clGetKernelArgInfo"></a> |
| <h1> |
| clGetKernelArgInfo |
| </h1> |
| <p> |
| Returns information about the arguments of a kernel. |
| </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">clGetKernelArgInfo</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="scalarDataTypes.html" target="pagedisplay">cl_uint</a> |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">arg_indx</var> |
| , </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td> |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_kernel_arg_info" target="pagedisplay">cl_kernel_arg_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"> arg_indx </code> </span> |
| </dt> |
| <dd> |
| <p> |
| The argument index. Arguments to the kernel are referred by indices that |
| go from 0 for the leftmost argument to <code class="varname">n</code> - 1, where |
| <code class="varname">n</code> is the total number of arguments declared by a kernel. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> <code class="varname"> param_name </code> </span> |
| </dt> |
| <dd> |
| <p> |
| Specifies the argument 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">clGetKernelArgInfo</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"> |
| <a id="cl_kernel_info"></a> |
| <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_arg_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_ARG_ADDRESS_QUALIFIER</code> |
| </td> |
| <td align="left">cl_kernel_arg_- |
| address_qualifier</td> |
| <td align="left"> |
| <p> |
| Returns the address qualifier specified for the |
| argument given by <code class="varname">arg_indx</code>. |
| This can be one of the following values: |
| |
| </p><div class="literallayout"><p><br /> |
| <code class="constant">CL_KERNEL_ARG_ADDRESS_GLOBAL</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ADDRESS_LOCAL</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ADDRESS_CONSTANT</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ADDRESS_PRIVATE</code><br /> |
| </p></div><p> |
| </p> |
| |
| <p> |
| If no address qualifier is specified, the default address |
| qualifier which is <code class="constant">CL_KERNEL_ARG_ADDRESS_PRIVATE</code> is returned. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_ARG_ACCESS_QUALIFIER</code> |
| </td> |
| <td align="left">cl_kernel_arg_- |
| access_qualifier</td> |
| <td align="left"> |
| <p> |
| Returns the access qualifier specified for the |
| argument given by <code class="varname">arg_indx</code>. |
| This can be one of the following values: |
| |
| </p><div class="literallayout"><p><br /> |
| <code class="constant">CL_KERNEL_ARG_ACCESS_READ_ONLY</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ACCESS_WRITE_ONLY</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ACCESS_READ_WRITE</code><br /> |
| <code class="constant">CL_KERNEL_ARG_ACCESS_NONE</code><br /> |
| </p></div><p> |
| </p> |
| |
| <p> |
| If argument is not an image type |
| and is not declared with the <code class="code">pipe</code> qualifier, |
| <code class="constant">CL_KERNEL_ARG_ACCESS_NONE</code> is |
| returned. If argument is an image type, the access qualifier |
| specified or the default access qualifier is returned. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_ARG_TYPE_NAME</code> |
| </td> |
| <td align="left">char[]</td> |
| <td align="left"> |
| <p> |
| Returns the type name specified for the argument given |
| by <code class="varname">arg_indx</code>. The type name returned |
| will be the argument type name as it was declared with any |
| whitespace removed. If argument type name is an unsigned |
| scalar type (i.e. unsigned char, unsigned short, unsigned |
| int, unsigned long), uchar, ushort, uint and ulong will |
| be returned. The argument type name returned does not |
| include any type qualifiers. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_ARG_TYPE_QUALIFIER</code> |
| </td> |
| <td align="left">cl_kernel_arg- |
| type_qualifier</td> |
| <td align="left"> |
| <p> |
| Returns the type qualifier specified for the argument |
| given by <code class="varname">arg_indx</code>. The returned value |
| can be: <code class="constant">CL_KERNEL_ARG_TYPE_CONST</code>, |
| <code class="constant">CL_KERNEL_ARG_TYPE_RESTRICT</code>, |
| <code class="constant">CL_KERNEL_ARG_TYPE_VOLATILE</code>, |
| a combination of the above enums, |
| <code class="constant">CL_KERNEL_ARG_TYPE_PIPE</code> or |
| <code class="constant">CL_KERNEL_ARG_TYPE_NONE</code>. |
| </p> |
| |
| <p> |
| NOTE: <code class="constant">CL_KERNEL_ARG_TYPE_VOLATILE</code> |
| is returned if the argument is a pointer and the pointer |
| is declared with the volatile qualifier. |
| For example, a kernel argument declared |
| as <code class="code">global int volatile *x</code> returns |
| <code class="constant">CL_KERNEL_ARG_TYPE_VOLATILE</code> but |
| a kernel argument declared as <code class="code">global int * |
| volatile x</code> does not. Similarly, |
| <code class="constant">CL_KERNEL_ARG_TYPE_CONST</code> is returned if the |
| argument is a pointer and the referenced type is |
| declared with the restrict or const qualifier. For |
| example, a kernel argument declared as <code class="code">global |
| int const *x</code> returns |
| <code class="constant">CL_KERNEL_ARG_TYPE_CONST</code> but |
| a kernel argument declared as <code class="code">global int * |
| const x</code> does not. |
| </p> |
| |
| <p> |
| If the argument is declared with the constant address |
| space qualifier, the |
| <code class="constant">CL_KERNEL_ARG_TYPE_CONST</code> type qualifier |
| will be set. |
| </p> |
| |
| <p> |
| <code class="constant">CL_KERNEL_ARG_TYPE_RESTRICT</code> will be returned |
| if the pointer type is marked restrict. For example, |
| <code class="code">global int * restrict x</code> returns |
| <code class="constant">CL_KERNEL_ARG_TYPE_RESTRICT</code>. |
| </p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_KERNEL_ARG_NAME</code> |
| </td> |
| <td align="left">char[]</td> |
| <td align="left"> |
| <p> |
| Returns the name specified for the argument given by <code class="varname">arg_indx</code>. |
| </p> |
| </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="notes"></a> |
| <h2>Notes</h2> |
| <p> |
| Kernel argument information is only available if the program |
| object associated with <code class="varname">kernel</code> was created with |
| <a class="citerefentry" href="clCreateProgramWithSource.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithSource</span></span></a> |
| and the program executable is built with the -cl-kernel-arg-info |
| option specified in <code class="varname">options</code> argument to |
| <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a> or |
| <a class="citerefentry" href="clCompileProgram.html"><span class="citerefentry"><span class="refentrytitle">clCompileProgram</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. 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_ARG_INDEX</span> if <code class="varname">arg_indx</code> |
| is not a valid argument index. |
| </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_KERNEL_ARG_INFO_NOT_AVAILABLE</span> if the argument |
| information is not available for kernel. |
| </li> |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_KERNEL</span> if <code class="varname">kernel</code> |
| is not a valid kernel object. |
| </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=clGetKernelArgInfo" 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="clGetKernelInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelInfo</span></span></a>, |
| <a class="citerefentry" href="clCreateKernelsInProgram.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernelsInProgram</span></span></a>, |
| <a class="citerefentry" href="clCreateProgramWithSource.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithSource</span></span></a>, |
| <a class="citerefentry" href="clBuildProgram.html"><span class="citerefentry"><span class="refentrytitle">clBuildProgram</span></span></a>, |
| <a class="citerefentry" href="clSetKernelArg.html"><span class="citerefentry"><span class="refentrytitle">clSetKernelArg</span></span></a>, |
| <a class="citerefentry" href="clGetKernelWorkGroupInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelWorkGroupInfo</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> |
