| <?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"> |
| |
| <refentry> |
| <refentryinfo> |
| <keywordset> |
| <keyword>cl_khr_gl_msaa_sharing</keyword> |
| </keywordset> |
| </refentryinfo> |
| |
| <refmeta> |
| <refentrytitle>cl_khr_gl_msaa_sharing</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="cl_khr_gl_msaa_sharing"> |
| <refname>cl_khr_gl_msaa_sharing</refname> |
| |
| <refpurpose> |
| Extends the CL/GL sharing to support GL multi-sampled texture (color or depth). |
| </refpurpose> |
| </refnamediv> |
| |
| <!-- ALTERNATIVE SYNTAX SYNOPSIS (NON-FUNCTION) --> |
| |
| <refsect2 id="synopsis"> |
| <title> |
| </title> |
| |
| <informaltable frame="none"> |
| <tgroup cols="1" align="left" colsep="0" rowsep="0"> |
| <colspec colname="col1" colnum="1" /> |
| <tbody> |
| <row> |
| <entry> |
| #pragma OPENCL EXTENSION cl_khr_gl_msaa_sharing : enable |
| </entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| </refsect2> |
| |
| <!-- ================================ DESCRIPTION --> |
| |
| <refsect1 id="description"><title>Description</title> |
| <para> |
| This extension name is <function>cl_khr_gl_msaa_sharing</function>. This extension requires |
| <citerefentry><refentrytitle>cl_khr_gl_depth_images</refentrytitle></citerefentry>. |
| </para> |
| |
| <para> |
| This extension adds read_image and write_image functions to the |
| <citerefentry href="imageFunctions"><refentrytitle>Image Read and Write Functions</refentrytitle></citerefentry>. |
| </para> |
| |
| <para> |
| Multi-sample CL image objects (MSAA) can only be read |
| from a kernel. Multi-sample CL image objects |
| cannot be used as arguments to |
| <citerefentry><refentrytitle>clEnqueueReadImage</refentrytitle></citerefentry> , |
| <citerefentry><refentrytitle>clEnqueueWriteImage</refentrytitle></citerefentry>, |
| <citerefentry><refentrytitle>clEnqueueCopyImage</refentrytitle></citerefentry>, |
| <citerefentry><refentrytitle>clEnqueueCopyImageToBuffer</refentrytitle></citerefentry>, |
| <citerefentry><refentrytitle>clEnqueueCopyBufferToImage</refentrytitle></citerefentry>, |
| <citerefentry><refentrytitle>clEnqueueMapImage</refentrytitle></citerefentry> and |
| <citerefentry><refentrytitle>clEnqueueFillImage</refentrytitle></citerefentry> and will return a |
| <errorname>CL_INVALID_OPERATION</errorname> error. |
| </para> |
| |
| <para> |
| Add the following new data types to table 6.3 in section 6.1.3 of the OpenCL 2.1 specification |
| (see <citerefentry><refentrytitle>otherDataTypes</refentrytitle></citerefentry>): |
| </para> |
| |
| <informaltable frame="all"> |
| <tgroup cols="2" align="left" colsep="1" rowsep="1"> |
| <colspec colname="col1" colnum="1" /> |
| <colspec colname="col2" colnum="2" /> |
| <thead> |
| <row> |
| <entry>Type</entry> |
| <entry>Description</entry> |
| </row> |
| </thead> |
| |
| <tbody> |
| <row> |
| <entry><type>image2d_msaa_t</type></entry> |
| <entry>A 2D multi-sample color image. Refer to section |
| 6.13.14 for a detailed description of the built-in |
| functions that use this type.</entry> |
| </row> |
| |
| <row> |
| <entry><type>image2d_array_msaa_t</type></entry> |
| <entry>A 2D multi-sample color image array. Refer to |
| section 6.13.14 for a detailed description of the |
| built-in functions that use this type.</entry> |
| </row> |
| |
| <row> |
| <entry><type>image2d_msaa_depth_t</type></entry> |
| <entry>A 2D multi-sample depth image. Refer to section |
| 6.13.14 for a detailed description of the built-in |
| functions that use this type.</entry> |
| </row> |
| |
| <row> |
| <entry><type>image2d_array_msaa_depth_t</type></entry> |
| <entry>A 2D multi-sample depth image array. Refer to |
| section 6.13.14 for a detailed description of the |
| built-in functions that use this type.</entry> |
| </row> |
| </tbody> |
| </tgroup> |
| </informaltable> |
| |
| <para> |
| NOTE: When a multisample image is accessed in a |
| kernel, the access takes one vector of |
| integers describing which pixel to fetch and |
| an integer corresponding to the sample numbers |
| describing which sample within the pixel to |
| fetch. sample identifies the sample position in the |
| multi-sample image. |
| </para> |
| |
| <para> |
| For best performance, we recommend that |
| <varname>sample</varname> be a literal value so it is known at |
| compile time and the OpenCL compiler can |
| perform appropriate optimizations for multisample reads on the device. |
| </para> |
| |
| <para> |
| No standard sampling instructions are allowed on |
| the multisample image. Accessing a coordinate |
| outside the image and/or a sample that is outside |
| the number of samples associated with each |
| pixel in the image is undefined |
| </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="cl_khr_gl_msaa_sharing">OpenCL Specification</olink> |
| </para> |
| </refsect1> |
| |
| <!-- ================================ ALSO SEE --> |
| |
| <refsect1 id="seealso"><title>Also see</title> |
| <citerefentry href="imageFunctions"><refentrytitle>Image Read and Write Functions</refentrytitle></citerefentry>, |
| <citerefentry><refentrytitle>clGetGLTextureInfo</refentrytitle></citerefentry> |
| </refsect1> |
| |
| <!-- ============================== COPYRIGHT --> |
| <!-- Content included from copyright.inc.xsl --> |
| |
| <refsect3 id="Copyright"><title></title> |
| <imageobject> |
| <imagedata fileref="KhronosLogo.jpg" format="jpg" /> |
| </imageobject> |
| </refsect3> |
| |
| <!-- 26-Oct-2015, Ext rev. 10 --> |
| </refentry> |
| |