| <?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>clGetDeviceInfo</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> |
| <meta name="keywords" content="clGetDeviceInfo" /> |
| </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="clGetDeviceInfo"></a> |
| <h1>clGetDeviceInfo</h1> |
| <p>Get information about an OpenCL 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="_top">cl_int</a> <strong class="fsfunc">clGetDeviceInfo</strong>(</code> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="_top">cl_device_id</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">device</var>, </td> |
| </td> |
| </tr> |
| <tr valign="top"> |
| <td> </td> |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_device_info" target="_top">cl_device_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="_top">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="_top">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="_top">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">device</code> |
| </span> |
| </dt> |
| <dd> |
| <p>Refers to the device returned by <a class="citerefentry" href="clGetDeviceIDs.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDs</span></span></a>.</p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">param_name</code> |
| </span> |
| </dt> |
| <dd> |
| <p>An enumeration constant that identifies the device information being queried. It can be one of the values as specified in the table below.</p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">param_value</code> |
| </span> |
| </dt> |
| <dd> |
| <p>A pointer to memory location where appropriate values for a given <code class="varname">param_name</code> as specified in the table below will be 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>Specifies the size in bytes of memory pointed to by <code class="varname">param_value</code>. This size in bytes must be greater than or equal to size of return type specified 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 being queried by <code class="varname">param_value</code>. If <code class="varname">param_value_size_ret</code> is NULL, it is ignored</p> |
| </dd> |
| <dt> |
| <span class="term"></span> |
| </dt> |
| <dd> |
| <div class="informaltable"> |
| <table border="1"> |
| <colgroup> |
| <col align="left" class="col1" /> |
| <col align="left" class="col2" /> |
| </colgroup> |
| <thead> |
| <tr> |
| <th align="left">cl_device_info</th> |
| <th align="left">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_ADDRESS_BITS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>The default compute device address space size specified as an unsigned integer value in bits. Currently supported values are 32 or 64 bits.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_AVAILABLE</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_TRUE if the device is available and CL_FALSE if the device is not available.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_COMPILER_AVAILABLE</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_FALSE if the implementation does not have a compiler available to compile the program source. Is CL_TRUE if the compiler is |
| available. This can be CL_FALSE for the embedded platform profile only.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_DOUBLE_FP_CONFIG</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_fp_config</p> |
| <p>Describes the OPTIONAL double precision floating-point capability of the OpenCL device. This is a bit-field that describes one or more of the following values:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem" style="list-style-type: disc">CL_FP_DENORM - denorms are supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_INF_NAN - INF and NaNs are supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_NEAREST - round to nearest even rounding mode supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_ZERO - round to zero rounding mode supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_INF - round to +ve and -ve infinity rounding modes supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_FMA - IEEE754-2008 fused multiply-add is supported. </li></ul></div> |
| <p>The mandated minimum double precision floating-point capability is CL_FP_FMA | CL_FP_ROUND_TO_NEAREST | CL_FP_ROUND_TO_ZERO | CL_FP_ROUND_TO_INF | CL_FP_INF_NAN | CL_FP_DENORM.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_ENDIAN_LITTLE</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_TRUE if the OpenCL device is a little endian device and CL_FALSE otherwise.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_ERROR_CORRECTION_SUPPORT</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_TRUE if the device implements error correction for all accesses to compute device memory (global and constant). |
| Is CL_FALSE if the device does not implement such error correction.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_EXECUTION_CAPABILITIES</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_exec_capabilities</p> |
| <p>Describes the execution capabilities of the device. This is a bit-field that describes one or more of the following values:</p> |
| <p>CL_EXEC_KERNEL - The OpenCL device can execute OpenCL kernels.</p> |
| <p>CL_EXEC_NATIVE_KERNEL - The OpenCL device can execute native kernels.</p> |
| <p>The mandated minimum capability is CL_EXEC_KERNEL.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_EXTENSIONS</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>Returns a space-separated list of extension names (the extension names themselves do not contain any spaces). The list of extension names returned currently can include one or more of the following approved extension names:</p> |
| <p> |
| </p><div class="literallayout"><p><a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a><br /> |
| <a class="citerefentry" href="cl_khr_int64_base_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_base_atomics</span></span></a><br /> |
| <a class="citerefentry" href="cl_khr_int64_extended_atomics.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_int64_extended_atomics</span></span></a><br /> |
| <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a><br /> |
| <a class="citerefentry" href="gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_sharing</span></span></a><br /> |
| <a class="citerefentry" href="gl_event.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_event</span></span></a><br /> |
| <a class="citerefentry" href="cl_khr_d3d10_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d10_sharing</span></span></a><br /> |
| </p></div> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_GLOBAL_MEM_CACHE_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_ulong</p> |
| <p>Size of global memory cache in bytes.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_GLOBAL_MEM_CACHE_TYPE</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_mem_cache_type</p> |
| <p>Type of global memory cache supported. Valid values are: CL_NONE, |
| CL_READ_ONLY_CACHE, and CL_READ_WRITE_CACHE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Size of global memory cache line in bytes.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_GLOBAL_MEM_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_ulong</p> |
| <p>Size of global device memory in bytes.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_HALF_FP_CONFIG</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_fp_config</p> |
| <p>Describes the OPTIONAL half precision floating-point capability of the OpenCL device. This is a bit-field that describes one or more of the following values:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem" style="list-style-type: disc">CL_FP_DENORM - denorms are supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_INF_NAN - INF and NaNs are supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_NEAREST - round to nearest even rounding mode supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_ZERO - round to zero rounding mode supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_ROUND_TO_INF - round to +ve and -ve infinity rounding modes supported.</li><li class="listitem" style="list-style-type: disc">CL_FP_FMA - IEEE754-2008 fused multiply-add is supported. </li><li class="listitem" style="list-style-type: disc">CL_FP_SOFT_FLOAT - Basic floating-point operations (such as addition, subtraction, multiplication) are implemented in software. </li></ul></div> |
| <p>The required minimum half precision floating-point capability as implemented by this extension is CL_FP_ROUND_TO_ZERO or |
| CL_FP_ROUND_TO_INF | CL_FP_INF_NAN.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_HOST_UNIFIED_MEMORY</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_TRUE if the device and the host have a unified memory subsystem and is CL_FALSE otherwise.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE_SUPPORT</code> |
| </td> |
| <td align="left"><p>Return type: cl_bool</p> |
| <p>Is CL_TRUE if images are supported by the OpenCL device and CL_FALSE |
| otherwise.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE2D_MAX_HEIGHT</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max height of 2D image in pixels. The minimum value is 8192 if |
| CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE2D_MAX_WIDTH</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max width of 2D image in pixels. The minimum value is 8192 if |
| CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE3D_MAX_DEPTH</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max depth of 3D image in pixels. The minimum value is 2048 if |
| CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE3D_MAX_HEIGHT</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max height of 3D image in pixels. The minimum value is 2048 if |
| CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_IMAGE3D_MAX_WIDTH</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max width of 3D image in pixels. The minimum value is 2048 if |
| CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_LOCAL_MEM_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_ulong</p> |
| <p>Size of local memory arena in bytes. The minimum value is 32 KB.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_LOCAL_MEM_TYPE</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_local_mem_type</p> |
| <p>Type of local memory supported. This can be set to CL_LOCAL implying |
| dedicated local memory storage such as SRAM, or CL_GLOBAL.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_CLOCK_FREQUENCY</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Maximum configured clock frequency of the device in MHz.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_COMPUTE_UNITS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>The number of parallel compute cores on the OpenCL device. The minimum value is 1.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_CONSTANT_ARGS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Max number of arguments declared with the <a class="citerefentry" href="constant.html"><span class="citerefentry"><span class="refentrytitle">__constant</span></span></a> qualifier in a |
| kernel. The minimum value is 8.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_ulong</p> |
| <p>Max size in bytes of a constant buffer allocation. The minimum value is 64 KB.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_MEM_ALLOC_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_ulong</p> |
| <p>Max size of memory object allocation in bytes. The minimum value is max (1/4th of CL_DEVICE_GLOBAL_MEM_SIZE, 128*1024*1024)</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_PARAMETER_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Max size in bytes of the arguments that can be passed to a kernel. The minimum value is 1024. For this minimum value, only a maximum of 128 arguments can be passed to a kernel.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_READ_IMAGE_ARGS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Max number of simultaneous image objects that can be read by a kernel. The minimum value is 128 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_SAMPLERS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Maximum number of samplers that can be used in a kernel. The minimum value is 16 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE. (Also see <a class="citerefentry" href="sampler_t.html"><span class="citerefentry"><span class="refentrytitle">sampler_t</span></span></a>.)</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_WORK_GROUP_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Maximum number of work-items in a work-group executing a kernel using |
| the data parallel execution model. (Refer to <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>). The minimum value is 1.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model. (Refer to <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>). The minimum value is 3.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_WORK_ITEM_SIZES</code> |
| </td> |
| <td align="left"><p>Return type: size_t[]</p> |
| <p>Maximum number of work-items that can be specified in each dimension of the work-group to <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>.</p> |
| <p>Returns <code class="varname">n</code> size_t entries, where <code class="varname">n</code> is the value returned by the query for CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS. The minimum value is (1, 1, 1).</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MAX_WRITE_IMAGE_ARGS</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Max number of simultaneous image objects that can be written to by a |
| kernel. The minimum value is 8 if CL_DEVICE_IMAGE_SUPPORT is CL_TRUE.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MEM_BASE_ADDR_ALIGN</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Describes the alignment in bits of the base address of any allocated memory object.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>The smallest alignment in bytes which can be used for any data type.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_NAME</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>Device name string.</p></td> |
| </tr> |
| <tr> |
| <td align="left"><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR</code> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT</code></p> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_INT</code></p> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG</code></p> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT</code></p> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE</code></p> |
| <p><code class="constant">CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF</code></p></td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Returns the native ISA vector width. The vector width is defined as the number of scalar elements that can be |
| stored in the vector.</p> |
| <p>If the <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a> extension is not supported, |
| CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE must return 0.</p> |
| <p>If the <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a> extension is not supported, |
| CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF must return 0.</p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_OPENCL_C_VERSION</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>OpenCL C version string. Returns the highest OpenCL C version supported by the compiler for this device. |
| This version string has the following format:</p> |
| <p><code class="varname">OpenCL<space>C<space><major_version.minor_version><space><vendor-specific information></code></p> |
| <p>The <code class="varname">major_version.minor_version</code> value must be 1.1 if CL_DEVICE_VERSION is OpenCL 1.1.</p> |
| <p>The <code class="varname">major_version.minor_version</code> value returned can be 1.0 or 1.1 if CL_DEVICE_VERSION |
| is OpenCL 1.0. If OpenCL C 1.1 is returned, this implies that the language feature set defined in |
| section 6 of the OpenCL 1.1 specification is supported by the OpenCL 1.0 device.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_PLATFORM</code> |
| </td> |
| <td align="left"><p>Return type: <a class="link" href="abstractDataTypes.html" target="_top">cl_platform_id</a></p> |
| <p>The platform associated with this device.</p></td> |
| </tr> |
| <tr> |
| <td align="left"><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR</code> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT</code></p> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT</code></p> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG</code></p> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT</code></p> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE</code></p> |
| <p><code class="constant">CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF</code></p></td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>Preferred native vector width size for built-in scalar types that can be put into vectors. The vector width is defined as the number of scalar elements that can be stored in the vector.</p> |
| <p>If the <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a> extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE must return 0.</p> |
| <p> |
| If the <a class="citerefentry" href="cl_khr_fp16.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp16</span></span></a> |
| extension is not supported, CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF must return 0. |
| </p> |
| |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_PROFILE</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>OpenCL profile string. Returns the profile name supported by the device (see note). The profile name returned can be one of the following strings:</p> |
| <p>FULL_PROFILE - if the device supports the OpenCL specification (functionality defined as part of the core specification and does not require any extensions to be supported).</p> |
| <p>EMBEDDED_PROFILE - if the device supports the OpenCL embedded profile.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_PROFILING_TIMER_RESOLUTION</code> |
| </td> |
| <td align="left"><p>Return type: size_t</p> |
| <p>Describes the resolution of device timer. This is measured in nanoseconds.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_QUEUE_PROPERTIES</code> |
| </td> |
| <td align="left"><p>Return type: cl_command_queue_properties</p> |
| <p>Describes the command-queue properties supported by the device. |
| This is a bit-field that describes one or more of the following values:</p> |
| <p>CL_QUEUE_OUT_OF_ORDER_EXEC_MODE_ENABLE</p> |
| <p>CL_QUEUE_PROFILING_ENABLE</p> |
| <p>These properties are described in the table for |
| <a class="citerefentry" href="clCreateCommandQueue.html"><span class="citerefentry"><span class="refentrytitle">clCreateCommandQueue</span></span></a>. The mandated minimum capability is CL_QUEUE_PROFILING_ENABLE.</p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_SINGLE_FP_CONFIG</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_fp_config</p> |
| <p>Describes single precision floating-point capability of the device. This is a bit-field that describes one or more of the following values:</p> |
| <p>CL_FP_DENORM - denorms are supported</p> |
| <p>CL_FP_INF_NAN - INF and quiet NaNs are supported</p> |
| <p>CL_FP_ROUND_TO_NEAREST - round to nearest even rounding mode supported</p> |
| <p>CL_FP_ROUND_TO_ZERO - round to zero rounding mode supported</p> |
| <p>CL_FP_ROUND_TO_INF - round to +ve and -ve infinity rounding modes supported</p> |
| <p>CL_FP_FMA - IEEE754-2008 fused multiply-add is supported</p> |
| <p>CL_FP_SOFT_FLOAT - Basic floating-point operations (such as addition, subtraction, multiplication) are implemented in software.</p> |
| <p>The mandated minimum floating-point capability is CL_FP_ROUND_TO_NEAREST | CL_FP_INF_NAN.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_TYPE</code> |
| </td> |
| <td align="left"><p>Return type: cl_device_type</p> |
| <p>The OpenCL device type. Currently supported values are one of or a combination of: CL_DEVICE_TYPE_CPU, CL_DEVICE_TYPE_GPU, CL_DEVICE_TYPE_ACCELERATOR, or CL_DEVICE_TYPE_DEFAULT.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_VENDOR</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>Vendor name string.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_VENDOR_ID</code> |
| </td> |
| <td align="left"><p>Return type: cl_uint</p> |
| <p>A unique device vendor identifier. An example of a unique device identifier could be the PCIe ID.</p> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DEVICE_VERSION</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>OpenCL version string. Returns the OpenCL version supported by the |
| device. This version string has the following format:</p> |
| <p><code class="varname">OpenCL<space><major_version.minor_version><space><vendor-specific information></code></p> |
| <p>The <code class="varname">major_version.minor_version</code> value returned will be 1.1.</p></td> |
| </tr> |
| <tr> |
| <td align="left"> |
| <code class="constant">CL_DRIVER_VERSION</code> |
| </td> |
| <td align="left"><p>Return type: char[]</p> |
| <p>OpenCL software driver version string in the form <code class="varname">major_number.minor_number</code>.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="notes"></a> |
| <h2>Notes</h2> |
| <p> |
| CL_DEVICE_PROFILE: The platform profile returns the profile that is implemented by the OpenCL framework. If the platform profile returned is FULL_PROFILE, the OpenCL framework will support devices that are FULL_PROFILE and may also support devices that are EMBEDDED_PROFILE. The compiler must be available for all devices i.e. CL_DEVICE_COMPILER_AVAILABLE is CL_TRUE. If the platform profile returned is EMBEDDED_PROFILE, then devices that are only EMBEDDED_PROFILE are supported. |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="errors"></a> |
| <h2>Errors</h2> |
| <p><code class="function">clGetDeviceInfo</code> returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully. Otherwise, it returns the following:</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 valid. |
| </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 one of the supported values or if size in |
| bytes specified by <code class="varname">param_value_size</code> is less than size of return type as shown in the table above and |
| <code class="varname">param_value</code> is not a <span class="errorname">NULL</span> value. |
| </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="http://www.khronos.org/registry/cl/specs/opencl-1.1.pdf#page=36" target="OpenCL Spec">OpenCL Specification</a> |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="seealso"></a> |
| <h2>Also see</h2> |
| <p> |
| <a class="citerefentry" href="clGetDeviceIDs.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDs</span></span></a>, |
| <a class="citerefentry" href="cl_khr_fp64.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_fp64</span></span></a>, |
| <a class="citerefentry" href="constant.html"><span class="citerefentry"><span class="refentrytitle">__constant</span></span></a>, |
| <a class="citerefentry" href="clCreateCommandQueue.html"><span class="citerefentry"><span class="refentrytitle">clCreateCommandQueue</span></span></a>, |
| <a class="citerefentry" href="clRetainCommandQueue.html"><span class="citerefentry"><span class="refentrytitle">clRetainCommandQueue</span></span></a>, |
| <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</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> |
| Copyright © |
| Copyright © 2007-2010 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> |
