| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
| "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd" [ | |
| <!ENTITY imageQueryFunctionsInc SYSTEM "imageQueryFunctionsInc.xml"> | |
| ]> | |
| <refentry> | |
| <refentryinfo> | |
| <keywordset> | |
| <keyword>get_image_dim</keyword> | |
| </keywordset> | |
| </refentryinfo> | |
| <refmeta> | |
| <refentrytitle>get_image_dim</refentrytitle> | |
| <refmiscinfo> | |
| <copyright> | |
| <year>2007-2013</year> | |
| <holder>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.</holder> | |
| </copyright> | |
| </refmiscinfo> | |
| <manvolnum>3</manvolnum> | |
| </refmeta> | |
| <!-- ================================ SYNOPSIS --> | |
| <refnamediv id="get_image_dim"> | |
| <refname>get_image_dim</refname> | |
| <refpurpose> | |
| Return the image dimensions. | |
| </refpurpose> | |
| </refnamediv> | |
| <refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| aQual <link xlink:href="otherDataTypes.html">image2d_t</link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| aQual <link xlink:href="otherDataTypes.html">image2d_array_t</link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int4</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| aQual <link xlink:href="otherDataTypes.html">image3d_t</link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| aQual <link xlink:href="otherDataTypes.html">image2d_depth_t</link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| aQual <link xlink:href="otherDataTypes.html">image2d_array_depth_t</link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <bridgehead>Functions added with MSAA support enabled by extension | |
| <code>cl_khr_gl_msaa_sharing</code>:</bridgehead> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| <link xlink:href="otherDataTypes.html">image2d_msaa_t </link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| <link xlink:href="otherDataTypes.html">image2d_array_msaa_t </link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| <link xlink:href="otherDataTypes.html">image2d_msaa_depth_t </link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| <funcsynopsis> | |
| <funcprototype> | |
| <funcdef> | |
| <link xlink:href="vectorDataTypes.html">int2</link> | |
| <function> | |
| get_image_dim | |
| </function> | |
| </funcdef> | |
| <paramdef> | |
| <link xlink:href="otherDataTypes.html">image2d_array_msaa_depth_t </link> | |
| <parameter>image</parameter> | |
| </paramdef> | |
| </funcprototype> | |
| </funcsynopsis> | |
| </refsynopsisdiv> | |
| <!-- ================================ DESCRIPTION --> | |
| <refsect1 id="description"><title>Description</title> | |
| &imageQueryFunctionsInc; | |
| <para> | |
| <function>get_image_dim</function> with <citerefentry | |
| href="otherDataTypes"><refentrytitle>image2d_t</refentrytitle></citerefentry>, | |
| <citerefentry href="otherDataTypes"><refentrytitle>image2d_array_t</refentrytitle></citerefentry>, | |
| <citerefentry href="otherDataTypes"><refentrytitle>image2d_depth_t</refentrytitle></citerefentry>, and | |
| <citerefentry href="otherDataTypes"><refentrytitle>image2d_array_depth_t</refentrytitle></citerefentry> | |
| returns the 2D image width and height as an <type>int2</type> type. The width is returned | |
| in the <emphasis>x</emphasis> component, and the height in the <emphasis>y</emphasis> | |
| component. | |
| </para> | |
| <para> | |
| <function>get_image_dim</function> with <citerefentry | |
| href="otherDataTypes"><refentrytitle>image3d_t</refentrytitle></citerefentry> returns | |
| the 3D image width, height, and depth as an <type>int4</type> type. The width is | |
| returned in the <emphasis>x</emphasis> component, height in the <emphasis>y</emphasis> | |
| component, depth in the <emphasis>z</emphasis> component and the <emphasis>w</emphasis> | |
| component is 0. | |
| </para> | |
| </refsect1> | |
| <!-- ================================ NOTES | |
| <refsect1 id="notes"><title>Notes</title> | |
| <para> | |
| </para> | |
| </refsect1>--> | |
| <!-- ================================ EXAMPLE --> | |
| <!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE --> | |
| <!-- | |
| <refsect2 id="example1"> | |
| <title> | |
| Example | |
| </title> | |
| <informaltable frame="none"> | |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> | |
| <colspec colname="col1" colnum="1" /> | |
| <tbody> | |
| <row> | |
| <entry> | |
| Example goes here - it will be set in "code" type with white space preserved. | |
| </entry> | |
| </row> | |
| </tbody> | |
| </tgroup> | |
| </informaltable> | |
| </refsect2> | |
| --> | |
| <!-- ================================ SPECIFICATION --> | |
| <!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page | |
| --> | |
| <refsect1 id="specification"><title>Specification</title> | |
| <para> | |
| <imageobject> | |
| <imagedata fileref="pdficon_small1.gif" format="gif" /> | |
| </imageobject> | |
| <olink uri="imageFunctions">OpenCL Specification</olink> | |
| </para> | |
| </refsect1> | |
| <!-- ================================ ALSO SEE --> | |
| <refsect1 id="seealso"><title>Also see</title> | |
| <para> | |
| <citerefentry href="imageFunctions"><refentrytitle>Image Functions</refentrytitle></citerefentry>, | |
| <citerefentry><refentrytitle>cl_khr_gl_msaa_sharing</refentrytitle></citerefentry> | |
| </para> | |
| </refsect1> | |
| <!-- ============================== COPYRIGHT --> | |
| <!-- Content included from copyright.inc.xsl --> | |
| <refsect3 id="Copyright"><title></title> | |
| <imageobject> | |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> | |
| </imageobject> | |
| <para /> | |
| </refsect3> | |
| <!-- 28-Oct-2015, Ext ver 2.1 rev 10; C lang ver 2.0 rev 30 --> | |
| </refentry> | |