blob: c5806155cf026037b216936c5a152ca44b75386b [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"" [
<!ENTITY mediaSurfaceFormatsInc SYSTEM "mediaSurfaceFormatsInc.xml">
<!ENTITY accessMappedInc SYSTEM "accessMappedInc.xml">
<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>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clCreateFromDX9MediaSurfaceKHR">
<refpurpose>Creates an OpenCL image object from a media surface.</refpurpose>
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="abstractDataTypes.html">cl_mem</link>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_mem_flags">cl_mem_flags</link><parameter>flags</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">void</link><parameter>*surface_info</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_uint</link><parameter>plane</parameter></paramdef>
<link xlink:href="scalarDataTypes.html">cl_int</link>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters"><title>Parameters</title>
A valid OpenCL context created from a media adapter.
A bit-field that is used to specify usage information. Refer
to the table of allowed values for <varname>flags</varname> for
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>. Only
<constant>CL_MEM_READ_ONLY</constant>, <constant>CL_MEM_WRITE_ONLY</constant>,
and <constant>CL_MEM_READ_WRITE</constant> values specified
in the table of allowed values for <varname>flags</varname> for
can be used.
A value from enumeration of supported adapters described in the
table of <varname>cl_dx9_media_adapter_type_khr</varname> values for
The type of <varname>surface_info</varname> is determined by the adapter
type. The implementation does not need to support all adapter types. This
approach provides flexibility to support additional adapter types in the
future. Supported adapter types are <constant>CL_ADAPTER_D3D9_KHR</constant>,
<constant>CL_ADAPTER_D3D9EX_KHR</constant>, and
If <varname>adapter_type</varname> is <constant>CL_ADAPTER_D3D9_KHR</constant>,
<constant>CL_ADAPTER_D3D9EX_KHR</constant>, or
<constant>CL_ADAPTER_DXVA_KHR</constant>, the <varname>surface_info</varname>
points to the following structure:
<para> <code><literallayout>typedef struct _cl_dx9_surface_info_khr
IDirect3DSurface9 *resource; HANDLE shared_handle;
} cl_dx9_surface_info_khr;
For D3D9 surfaces, we need both the handle to the resource and the resource
itself to have a sufficient amount of information to eliminate a copy of the
surface for sharing in cases where this is possible. Elimination of the copy
is driver dependent. <varname>shared_handle</varname> may be NULL and this
may result in sub-optimal performance.
A pointer to one of the structures defined in the <varname>adapter_type</varname>
description above passed in as a <type>void</type> *.
The plane of resource to share for planar surface formats. For planar formats,
we use the plane parameter to obtain a handle to thie specific plane (Y, U or
V for example). For nonplanar formats used by media, <varname>plane</varname>
must be 0.
An appropriate error code. If <varname>errcode_ret</varname> is NULL, no
error code is returned.
</varlistentry> </variablelist>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
The width and height of the returned OpenCL 2D image object are determined by the
width and height of the plane of resource. The channel type and order of the returned
image object is determined by the format and plane of resource and are described in
tables 9.10.3 and 9.10.4.
This call will increment the internal media surface count on
<varname>resource</varname>. The internal media surface reference count on
<varname>resource</varname> will be decremented when the OpenCL reference count on
the returned OpenCL memory object drops to zero.
<bridgehead>DX9 Media Surface Sharing</bridgehead>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns <errorname>CL_SUCCESS</errorname> returns a valid non-zero 2D image object and
<varname>errcode_ret</varname> is set to <errorname>CL_SUCCESS</errorname> if the 2D
image object is created successfully. Otherwise, it returns a NULL value with one
of the following error values returned in <varname>errcode_ret</varname>:
<itemizedlist mark="disc">
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context.
<errorname>CL_INVALID_VALUE</errorname> if values specified in
<varname>flags</varname> are not valid or if plane is not a valid plane of
<varname>resource</varname> specified in <varname>surface_info</varname>..
<errorname>CL_INVALID_DX9_MEDIA_SURFACE_KHR</errorname> if
<varname>resource</varname> specified in <varname>surface_info</varname> is not
a valid resource or is not associated with <varname>adapter_type</varname> (e.g.,
<varname>adapter_type</varname> is set to <constant>CL_ADAPTER_D3D9_KHR</constant>
and <varname>resource</varname> is not a Direct3D 9 surface created in
<errorname>CL_INVALID_DX9_MEDIA_SURFACE_KHR</errorname> if
<varname>shared_handle</varname> specified in <varname>surface_info</varname>
is not NULL or a valid handle value.
<errorname>CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</errorname> if the texture format
of <varname>resource</varname> is not listed in tables 9.10.3 and 9.10.4.
<errorname>CL_INVALID_OPERATION</errorname> if there are no devices in
<varname>context</varname> that support <varname>adapter_type</varname>.
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ 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="clCreateFromDX9MediaSurfaceKHR">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 24-Oct-2011 -->