1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
<?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 sharingD3D10Inc SYSTEM "sharingD3D10Inc.xml">
]>
<refentry>
<refentryinfo>
<keywordset><keyword>clCreateFromD3D10Texture2DKHR</keyword></keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>clCreateFromD3D10Texture2DKHR</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</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="clCreateFromD3D10Texture2DKHR">
<refname>clCreateFromD3D10Texture2DKHR</refname>
<refpurpose>Creates an OpenCL 2D image object from a subresource of a Direct3D 10 2D texture.</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="abstractDataTypes.html">cl_mem</link>
<function>clCreateFromD3D10Texture2DKHR</function></funcdef>
<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>ID3D10Texture2D<parameter>*resource</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">UINT</link><parameter>subresource</parameter></paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">cl_int</link>
<parameter>*errcode_ret</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><varname>context</varname></term>
<listitem>
<para>
A valid OpenCL context created from a Direct3D 10 device.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>flags</varname></term>
<listitem>
<para>
A bit-field that is used to specify usage information.
May be <constant>CL_MEM_READ_ONLY</constant>, <constant>CL_MEM_WRITE_ONLY</constant>,
or <constant>CL_MEM_READ_WRITE</constant>. (See the table for
<citerefentry><refentrytitle>clCreateBuffer</refentrytitle></citerefentry>
for more information.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>resource</varname></term>
<listitem>
<para>
A pointer to the Direct3D 10 2D texture to share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>subresource</varname></term>
<listitem>
<para>
The subresource of <varname>resource</varname> to share.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>errcode_ret</varname></term>
<listitem>
<para>
An appropriate error code. If <varname>errcode_ret</varname> is NULL, no error code is returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
<para>
The width, height and depth of the returned OpenCL 2D image object are determined
by the width, height and depth of subresource <varname>subresource</varname> of
<varname>resource</varname>. The channel type and order of the returned OpenCL 2D
image object is determined by the format of <varname>resource</varname> as shown in of
Direct3D 10 and corresponding OpenCL image formats of <varname>resource</varname> in
<citerefentry><refentrytitle>clCreateFromD3D10Texture3DKHR</refentrytitle></citerefentry>.
</para>
<para>
This call will increment the internal Direct3D reference count on
<varname>resource</varname>. The internal Direct3D reference count on
<varname>resource</varname> will be decremented when the OpenCL reference count on
the returned OpenCL memory object drops to zero.
</para>
&sharingD3D10Inc;
</refsect1>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns <errorname>CL_SUCCESS</errorname> returns a valid non-zero OpenCL image object
and <varname>errcode_ret</varname> is set to <errorname>CL_SUCCESS</errorname> if the
image object is created successfully. Otherwise, it returns a NULL value with one of
the following error values returned in <varname>errcode_ret</varname>:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if values specified in
<varname>flags</varname> are not valid or if <varname>subresource</varname>
is not a valid subresource index for <varname>resource</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_D3D10_RESOURCE_KHR</errorname> if <varname>resource</varname>
is not a Direct3D 10 texture resource, if <varname>resource</varname>
was created with the D3D10_USAGE flag D3D10_USAGE_IMMUTABLE, if
a <varname>resource</varname> is a multisampled texture, if cl_mem from
subresource <varname>subresource</varname> of <varname>resource</varname> has
already been created using <function>clCreateFromD3D10Texture2DKHR</function>,
or if <varname>context</varname> was not created against the same Direct3D 10
device from which <varname>resource</varname> was created.
</listitem>
<listitem>
<errorname>CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</errorname> if the Direct3D
10 texture format of <varname>resource</varname> is not a value listed
in the table of Direct3D 10 and corresponding OpenCL image formats for
<citerefentry><refentrytitle>clCreateFromD3D10Texture3DKHR</refentrytitle></citerefentry>,
or if the Direct3D 10 texture format of <varname>resource</varname> does not map
to a supported OpenCL image format.
</listitem>
<listitem>
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</listitem>
</itemizedlist>
</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="clCreateFromD3D10Texture2DKHR">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>cl_khr_d3d10_sharing</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetDeviceIDsFromD3D10KHR</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateFromD3D10BufferKHR</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateFromD3D10Texture3DKHR</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clEnqueueAcquireD3D10ObjectsKHR</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clEnqueueReleaseD3D10ObjectsKHR</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>
<!-- 23-Oct-2011 -->
</refentry>
|