blob: 517c17fe558a1132fd77289e71fa956a3986b4d3 [file] [log] [blame]
<!-- table 4.5 applies to:
cl_context_properties properties in clCreateContext
cl_context_properties properties in clGetGLContextInfoKHR
cl_context_properties properties in clCreateContextFromType
-->
<para>List of supported <varname>properties</varname> (Table 4.5)</para>
<informaltable frame="all"><tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<colspec colname="col3" colnum="3" />
<thead>
<row>
<entry>cl_context_properties enum</entry>
<entry>Property value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_CONTEXT_PLATFORM</constant></entry>
<entry>cl_platform_id</entry>
<entry>Specifies the platform to use.</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_INTEROP_USER_SYNC</constant></entry>
<entry>cl_bool</entry>
<entry>Specifies whether the user is responsible for synchronization
between OpenCL and other APIs. Please refer to the specific sections
in the OpenCL 2.0 extension specification that describe sharing with
other APIs for restrictions on using this flag. If
<constant>CL_CONTEXT_INTEROP_USER_SYNC</constant> is not specified, a
default of <constant>CL_FALSE</constant> is assumed.
OpenCL / OpenGL sharing does not support the
<constant>CL_CONTEXT_INTEROP_USER_SYNC</constant>
property defined in table 4.5. Specifying this
property when creating a context with OpenCL /
OpenGL sharing will return an appropriate error.</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_D3D10_DEVICE_KHR</constant></entry>
<entry><type>ID3D10Device</type> *</entry>
<entry>
Specifies the <type>ID3D10Device</type> * to use for Direct3D 10
interoperability. The default value is NULL (applies if the extension
<citerefentry><refentrytitle>cl_khr_d3d10_sharing</refentrytitle></citerefentry>
is supported)
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_ADAPTER_D3D9_KHR</constant></entry>
<entry><type>IDirect3DDevice9</type> *</entry>
<entry>
Specifies an <type>IDirect3DDevice9</type>
to use for D3D9 interop (applies if the
<citerefentry><refentrytitle>cl_khr_dx9_media_sharing</refentrytitle></citerefentry>
extension is supported)
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_ADAPTER_D3D9EX_KHR</constant></entry>
<entry><type>IDirect3DDeviceEx</type> *</entry>
<entry>
Specifies an <type>IDirect3DDevice9Ex</type>
to use for D3D9 interop (applies if the
<citerefentry><refentrytitle>cl_khr_dx9_media_sharing</refentrytitle></citerefentry>
extension is supported)
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_ADAPTER_DXVA_KHR</constant></entry>
<entry><type>IDXVAHD_Device</type> *</entry>
<entry>
Specifies an <type>IDXVAHD_Device</type>
to use for DXVA interop (applies if the
<citerefentry><refentrytitle>cl_khr_dx9_media_sharing</refentrytitle></citerefentry>
extension is supported)
</entry>
</row>
<row>
<entry><constant>CL_GL_CONTEXT_KHR</constant></entry>
<entry>0, OpenGL context handle</entry>
<entry>
OpenGL context to associated
the OpenCL context with (available if the
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>
extension is enabled)
</entry>
</row>
<row>
<entry><constant>CL_CGL_SHAREGROUP_KHR</constant></entry>
<entry>0, CGL share group handle</entry>
<entry>
CGL share group to associate
the OpenCL context with (available if the
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>
extension is enabled)
</entry>
</row>
<row>
<entry><constant>CL_EGL_DISPLAY_KHR</constant></entry>
<entry> <constant>EGL_NO_DISPLAY</constant>, <type>EGLDisplay</type> handle </entry>
<entry>
EGLDisplay an OpenGL context was created with respect to (available if the
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>
extension is enabled)
</entry>
</row>
<row>
<entry><constant>CL_GLX_DISPLAY_KHR</constant></entry>
<entry>None, X handle</entry>
<entry>
X Display an OpenGL context was
created with respect to (available if the
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>
extension is enabled)
</entry>
</row>
<row>
<entry><constant>CL_WGL_HDC_KHR</constant></entry>
<entry>0, HDC handle</entry>
<entry>
HDC an OpenGL context was created with respect to (available if the
<citerefentry><refentrytitle>cl_khr_gl_sharing</refentrytitle></citerefentry>
extension is enabled)
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_D3D11_DEVICE_KHR</constant></entry>
<entry><type>ID3D11Device</type> *</entry>
<entry>
Specifies the <type>ID3D11Device</type> * to use for Direct3D
11 interoperability. The default value is NULL. (Applies if the
<citerefentry><refentrytitle>cl_khr_d3d11_sharing</refentrytitle></citerefentry>
extension is supported.)
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_MEMORY_INITIALIZE_KHR</constant></entry>
<entry><type>cl_context_memory-
_initialize_khr</type></entry>
<entry>
<para>
Describes which memory types for the
context must be initialized. This is a
bit-field, where the following values are
currently supported:
</para>
<para>
<constant>CL_CONTEXT_MEMORY_INITIALIZE_LOCAL_KHR</constant> - Initialize local memory
to zeros.
</para>
<para>
<constant>CL_CONTEXT_MEMORY_INITIALIZE_PRIVATE_KHR</constant> - Initialize private
memory to zeros.
</para>
<para>
(applies if the
<citerefentry><refentrytitle>cl_khr_initialize_memory</refentrytitle></citerefentry>
extension is supported)
</para>
</entry>
</row>
<row>
<entry><constant>CL_CONTEXT_TERMINATE_KHR</constant></entry>
<entry><type>cl_bool</type></entry>
<entry>
Specifies whether the context can be
terminated. The default value is
<constant>CL_FALSE</constant>.
(applies if the
<citerefentry><refentrytitle>cl_khr_terminate_context</refentrytitle></citerefentry>
extension is supported)
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- 21-Oct-2015, API rev. 19; Ext rev. 10 -->