blob: 7845908e1154b376fec1371008e42e0426711213 [file] [log] [blame]
<?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>Other Built-in Data Types</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="Other Data Types" />
</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="OtherDataTypes"></a>
<h1>Other Data Types</h1>
<p>
Other Built-in Data Types
</p>
</div>
<div class="refsect1">
<a id="description"></a>
<h2>Description</h2>
<p>
The following table describes other data types supported by OpenCL:
</p>
<p>
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left"> <span class="type">image2d_t</span> </td>
<td align="left">
A 2D image. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image3d_t</span> </td>
<td align="left">
A 3D image. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image2d_array_t</span> </td>
<td align="left">
A 2D image array. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image1d_t</span> </td>
<td align="left">
A 1D image. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image1d_buffer_t</span> </td>
<td align="left">
A 1D image created from a buffer object. See individual
<a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image1d_array_t</span> </td>
<td align="left">
A 1D image array. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image2d_depth_t</span> </td>
<td align="left">
A 2D depth image. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left"> <span class="type">image2d_array_depth_t</span> </td>
<td align="left">
A 2D depth image array. See individual <a class="citerefentry" href="imageFunctions.html"><span class="citerefentry"><span class="refentrytitle">Image
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left">
<a class="citerefentry" href="sampler_t.html"><span class="citerefentry"><span class="refentrytitle"><span class="type">sampler_t</span></span></span></a>
</td>
<td align="left">
A sampler type.
</td>
</tr>
<tr>
<td align="left"> <span class="type">queue_t</span> </td>
<td align="left">
A device command queue. This queue can only be used to
enqueue commands from kernels executing on the device.
</td>
</tr>
<tr>
<td align="left"> <span class="type">ndrange_t</span> </td>
<td align="left">
The N-dimensional range over which a kernel executes.
</td>
</tr>
<tr>
<td align="left"> <span class="type">clk_event_t</span> </td>
<td align="left">
A device side event that identifies a command enqueue to a
device command queue.
</td>
</tr>
<tr>
<td align="left"> <span class="type">reserve_id_t</span> </td>
<td align="left">
A reservation ID. This opaque type is used to identify the
reservation for reading and writing a pipe. Refer to section
6.13.16.
</td>
</tr>
<tr>
<td align="left">
<span class="type">event_t</span>
</td>
<td align="left">
An event. This can be used to identify async copies from global
to local memory and vice-versa. See individual <a class="citerefentry" href="asyncCopyFunctions.html"><span class="citerefentry"><span class="refentrytitle">Async Copy and Prefetch
Functions</span></span></a> for more information.
</td>
</tr>
<tr>
<td align="left">
<span class="type">cl_mem_fence_flags</span>
</td>
<td align="left">
This is a bitfield and can be 0 or a combination of the
following values ORed together:
<div class="literallayout"><p><br />
<code class="constant">CLK_GLOBAL_MEM_FENCE</code><br />
<code class="constant">CLK_LOCAL_MEM_FENCE</code><br />
<code class="constant">CLK_IMAGE_MEM_FENCE</code><br />
                                        </p></div>
<p>
These flags are described in detail in section 6.13.8 of the
OpenCL specification (see
<a class="citerefentry" href="syncFunctions.html"><span class="citerefentry"><span class="refentrytitle">syncFunctions</span></span></a>).
</p>
</td>
</tr>
<tr>
<td align="left">
<span class="type">image2d_msaa_t</span>
</td>
<td align="left">
If the <a class="citerefentry" href="cl_khr_gl_msaa_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_msaa_sharing</span></span></a>
extension is enabled: A 2D multi-sample color image.
</td>
</tr>
<tr>
<td align="left">
<span class="type">image2d_array_msaa_t</span>
</td>
<td align="left">
If the <a class="citerefentry" href="cl_khr_gl_msaa_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_msaa_sharing</span></span></a>
extension is enabled: A 2D multi-sample color image array.
</td>
</tr>
<tr>
<td align="left">
<span class="type">image2d_msaa_depth_t</span>
</td>
<td align="left">
If the <a class="citerefentry" href="cl_khr_gl_msaa_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_msaa_sharing</span></span></a>
extension is enabled: A 2D multi-sample depth image.
</td>
</tr>
<tr>
<td align="left">
<span class="type">image2d_array_msaa_depth_t</span>
</td>
<td align="left">
If the <a class="citerefentry" href="cl_khr_gl_msaa_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_msaa_sharing</span></span></a>
extension is enabled: A 2D multi-sample depth image array.
</td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
NOTE: The <span class="type">image2d_t</span>, <span class="type">image3d_t</span>, <span class="type">image2d_array_t</span>,
<span class="type">image1d_t</span>, <span class="type">image1d_buffer_t</span>, <span class="type">image1d_array_t</span>,
<span class="type">image2d_depth_t</span>, <span class="type">image2d_array_depth_t</span>
and <span class="type">sampler_t</span> types are only defined if the device
supports images i.e. <code class="constant">CL_DEVICE_IMAGE_SUPPORT</code>
is <code class="constant">CL_TRUE</code>. See the table for <code class="varname">param_name</code> for
<a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a> for details.
</p>
<p>
The C99 derived types (arrays, structs, union, function, and
pointers), constructed from the built-in data types described in
<a class="citerefentry" href="scalarDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Scalar Data Types</span></span></a>,
<a class="citerefentry" href="vectorDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Vector Data Types</span></span></a>, and
<a class="citerefentry" href="otherDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Other Data Types</span></span></a>
are also supported with certain
<a class="citerefentry" href="restrictions.html"><span class="citerefentry"><span class="refentrytitle">restrictions</span></span></a>
described in section 6.9.
</p>
<p>
The following tables describe the other built-in
data types in OpenCL described in table 6.3 and
the corresponding data type available to the application:
</p>
<p>
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
<th align="left">Type in OpenCL C</th>
<th align="left">API type for application</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<span class="type">queue_t</span>
</td>
<td align="left">
<span class="type">cl_command_queue</span>
</td>
</tr>
<tr>
<td align="left">
<span class="type">clk_event_t</span>
</td>
<td align="left">
<span class="type">cl_event</span>
</td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
</p>
</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.0-openclc.pdf#namedest=otherDataTypes" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="macroLimits.html"><span class="citerefentry"><span class="refentrytitle">Macros and Limits</span></span></a>,
<a class="citerefentry" href="scalarDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Scalar Data Types</span></span></a>,
<a class="citerefentry" href="vectorDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Vector Data Types</span></span></a>,
<a class="citerefentry" href="reservedDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Reserved Data Types</span></span></a>,
<a class="citerefentry" href="abstractDataTypes.html"><span class="citerefentry"><span class="refentrytitle">Abstract Data Types</span></span></a>,
<a class="citerefentry" href="enums.html"><span class="citerefentry"><span class="refentrytitle">Enumerated Data Types</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>