'\" t
.\"     Title: clCreateFromDX9MediaSurfaceKHR
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLCREATEFROMDX9MEDIA" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clCreateFromDX9MediaSurfaceKHR \- Creates an OpenCL image object from a media surface\&.
.SH ""
.HP \w'cl_mem\ clCreateFromDX9MediaSurfaceKHR('u
.BI "cl_mem clCreateFromDX9MediaSurfaceKHR(cl_context\ " "context" ", cl_mem_flags\ " "flags" ", cl_dx9_media_adapter_type_khr\ " "adapter_type" ", void\ *" "surface_info" ", cl_uint\ " "plane" ", cl_int\ *" "errcode_ret" ");"
.SH "PARAMETERS"
.PP
\fIcontext\fR
.RS 4
A valid OpenCL context created from a media adapter\&.
.RE
.PP
\fIflags\fR
.RS 4
A bit\-field that is used to specify usage information\&. Refer to the table of allowed values for
\fIflags\fR
for
\fBclCreateBuffer\fR(3clc)\&. Only
\fBCL_MEM_READ_ONLY\fR,
\fBCL_MEM_WRITE_ONLY\fR, and
\fBCL_MEM_READ_WRITE\fR
values specified in the table of allowed values for
\fIflags\fR
for
\fBclCreateBuffer\fR(3clc)
can be used\&.
.RE
.PP
\fIadapter_type\fR
.RS 4
A value from enumeration of supported adapters described in the table of
\fIcl_dx9_media_adapter_type_khr\fR
values for
\fBclGetDeviceIDsFromDX9MediaAdapterKHR\fR(3clc)\&. The type of
\fIsurface_info\fR
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
\fBCL_ADAPTER_D3D9_KHR\fR,
\fBCL_ADAPTER_D3D9EX_KHR\fR, and
\fBCL_ADAPTER_DXVA_KHR\fR\&.
.sp
If
\fIadapter_type\fR
is
\fBCL_ADAPTER_D3D9_KHR\fR,
\fBCL_ADAPTER_D3D9EX_KHR\fR, or
\fBCL_ADAPTER_DXVA_KHR\fR, the
\fIsurface_info\fR
points to the following structure:
.sp .if n \{\ .RS 4 .\} .nf typedef struct _cl_dx9_surface_info_khr { IDirect3DSurface9 *resource; HANDLE shared_handle; } cl_dx9_surface_info_khr; .fi .if n \{\ .RE .\}
.sp
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\&.
\fIshared_handle\fR
may be NULL and this may result in sub\-optimal performance\&.
.RE
.PP
\fIsurface_info\fR
.RS 4
A pointer to one of the structures defined in the
\fIadapter_type\fR
description above passed in as a
\fBvoid\fR
*\&.
.RE
.PP
\fIplane\fR
.RS 4
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,
\fIplane\fR
must be 0\&.
.RE
.PP
\fIerrcode_ret\fR
.RS 4
An appropriate error code\&. If
\fIerrcode_ret\fR
is NULL, no error code is returned\&.
.RE
.SH "NOTES"
.PP
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\&.
.PP
This call will increment the internal media surface count on
\fIresource\fR\&. The internal media surface reference count on
\fIresource\fR
will be decremented when the OpenCL reference count on the returned OpenCL memory object drops to zero\&.
DX9 Media Surface Sharing.PP
The goal of this extension is to allow applications to use media surfaces as OpenCL memory objects\&. This allows efficient sharing of data between OpenCL and selected adapter APIs (only DX9 for now)\&. If this extension is supported, an OpenCL image object can be created from a media surface and the OpenCL API can be used to execute kernels that read and/or write memory objects that are media surfaces\&. Note that OpenCL memory objects may be created from the adapter media surface if and only if the OpenCL context has been created from that adapter\&.
.PP
If this extension is supported by an implementation, the string "cl_khr_media_sharing" will be present in the
\fBCL_PLATFORM_EXTENSIONS\fR
or
\fBCL_DEVICE_EXTENSIONS\fR
string described in the table of allowed values for
\fIparam_name\fR
for
\fBclGetDeviceInfo\fR(3clc)\&.
.PP
As currently proposed the interfaces for this extension would be provided in
cl_dx9_media_sharing\&.h\&.
.PP
This section includes the D3D surface formats that are supported when the adapter type is one of the Direct 3D lineage \&. Using a D3D surface format not listed here is an error\&. To extend the use of this extension to support media adapters beyond DirectX9 tables similar to the ones in this section will need to be defined for the surface formats supported by the new media adapter\&. All implementations that support this extension are required to support the NV12 surface format, the other surface formats supported are the same surface formats that the adapter you are sharing with supports as long as they are listed in the two tables below\&.
.TS
allbox center tab(:);
cB cB.
T{
FOUR CC code
T}:T{
CL image format (channel order, channel data type)
T}
.T&
c c
c c
c c
c c
c c.
T{
FOURCC(\*(AqN\*(Aq, \*(AqV\*(Aq, \*(Aq1\*(Aq, \*(Aq2\*(Aq), Plane 0
T}:T{
\fBCL_R, CL_UNORM_INT8\fR
T}
T{
FOURCC(\*(AqN\*(Aq, \*(AqV\*(Aq, \*(Aq1\*(Aq, \*(Aq2\*(Aq), Plane 1
T}:T{
\fBCL_RG, CL_UNORM_INT8\fR
T}
T{
FOURCC(\*(AqY\*(Aq, \*(AqV\*(Aq, \*(Aq1\*(Aq, \*(Aq2\*(Aq), Plane 0
T}:T{
\fBCL_R, CL_UNORM_INT8\fR
T}
T{
FOURCC(\*(AqY\*(Aq, \*(AqV\*(Aq, \*(Aq1\*(Aq, \*(Aq2\*(Aq), Plane 1
T}:T{
\fBCL_R, CL_UNORM_INT8\fR
T}
T{
FOURCC(\*(AqY\*(Aq, \*(AqV\*(Aq, \*(Aq1\*(Aq, \*(Aq2\*(Aq), Plane 2
T}:T{
\fBCL_R, CL_UNORM_INT8\fR
T}
.TE
.sp 1
.PP
In the table above, NV12 Plane 0 corresponds to the luminance (Y) channel and Plane 1 corresponds to the UV channels\&. The YV12 Plane 0 corresponds to the Y channel, Plane 1 to the U channel and Plane 2 to the V channel\&. Note that the YUV formats map to
\fBCL_R\fR
and
\fBCL_RG\fR
but do not perform any YUV to RGB conversion and vice\-versa\&.
.TS
allbox center tab(:);
cB cB.
T{
D3D format
T}:T{
CL image format (channel order, channel data type)
T}
.T&
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c
c c.
T{
D3DFMT_R32F
T}:T{
\fBCL_R, CL_FLOAT\fR
T}
T{
D3DFMT_R16F
T}:T{
\fBCL_R, CL_HALF_FLOAT\fR
T}
T{
D3DFMT_L16
T}:T{
\fBCL_R, CL_UNORM_INT16\fR
T}
T{
D3DFMT_A8
T}:T{
\fBCL_A, CL_UNORM_INT8\fR
T}
T{
D3DFMT_L8
T}:T{
\fBCL_R, CL_UNORM_INT8\fR
T}
T{
D3DFMT_G32R32F
T}:T{
\fBCL_RG, CL_FLOAT\fR
T}
T{
D3DFMT_G16R16F
T}:T{
\fBCL_RG, CL_HALF_FLOAT\fR
T}
T{
D3DFMT_G16R16
T}:T{
\fBCL_RG, CL_UNORM_INT16\fR
T}
T{
D3DFMT_A8L8
T}:T{
\fBCL_RG, CL_UNORM_INT8\fR
T}
T{
D3DFMT_A32B32G32R32F
T}:T{
\fBCL_RGBA, CL_FLOAT\fR
T}
T{
D3DFMT_A16B16G16R16F
T}:T{
\fBCL_RGBA, CL_HALF_FLOAT\fR
T}
T{
D3DFMT_A16B16G16R16
T}:T{
\fBCL_RGBA, CL_UNORM_INT16\fR
T}
T{
D3DFMT_A8B8G8R8
T}:T{
\fBCL_RGBA, CL_UNORM_INT8\fR
T}
T{
D3DFMT_X8B8G8R8
T}:T{
\fBCL_RGBA, CL_UNORM_INT8\fR
T}
T{
D3DFMT_A8R8G8B8
T}:T{
\fBCL_BGRA, CL_UNORM_INT8\fR
T}
T{
D3DFMT_X8R8G8B8
T}:T{
\fBCL_BGRA, CL_UNORM_INT8\fR
T}
.TE
.sp 1
.PP
Note that D3D9 format names seem to imply that the order of the color channels are switched relative to OpenCL but this is not the case\&. For example, layout of channels for each pixel for D3DFMT_A32FB32FG32FR32F is the same as
\fBCL_RGBA\fR,
\fBCL_FLOAT\fR\&.
.PP
Properties of media surface objects may be queried using
\fBclGetMemObjectInfo\fR(3clc)
and
\fBclGetImageInfo\fR(3clc)
with
\fIparam_name\fR
\fBCL_MEM_MEDIA_ADAPTER_TYPE_KHR\fR,
\fBCL_MEM_MEDIA_SURFACE_INFO_KHR\fR
and
\fBCL_IMAGE_MEDIA_SURFACE_PLANE_KHR\fR
as described for
\fBclGetImageInfo\fR(3clc)
and in the information below about accessing mapped regions of a memory object\&.
Accessing mapped regions of a memory object.PP
This section describes the behavior of OpenCL commands that access mapped regions of a memory object\&.
.PP
The contents of the region of a memory object and associated memory objects (sub\-buffer objects or 1D image buffer objects that overlap this region) mapped for writing (i\&.e\&.
\fBCL_MAP_WRITE\fR
or
\fBCL_MAP_WRITE_INVALIDATE_REGION\fR
is set in
\fImap_flags\fR
argument to
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)) are considered to be undefined until this region is unmapped\&.
.PP
Multiple commands in command\-queues can map a region or overlapping regions of a memory object and associated memory objects (sub\-buffer objects or 1D image buffer objects that overlap this region) for reading (i\&.e\&.
\fImap_flags\fR
=
\fBCL_MAP_READ\fR)\&. The contents of the regions of a memory object mapped for reading can also be read by kernels and other OpenCL commands (such as
\fBclEnqueueCopyBuffer\fR(3clc)) executing on a device(s)\&.
.PP
Mapping (and unmapping) overlapped regions in a memory object and/or associated memory objects (sub\-buffer objects or 1D image buffer objects that overlap this region) for writing is an error and will result in
\fBCL_INVALID_OPERATION\fR
error returned by
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)\&.
.PP
If a memory object is currently mapped for writing, the application must ensure that the memory object is unmapped before any enqueued kernels or commands that read from or write to this memory object or any of its associated memory objects (sub\-buffer or 1D image buffer objects) or its parent object (if the memory object is a sub\-buffer or 1D image buffer object) begin execution; otherwise the behavior is undefined\&.
.PP
If a memory object is currently mapped for reading, the application must ensure that the memory object is unmapped before any enqueued kernels or commands that write to this memory object or any of its associated memory objects (sub\-buffer or 1D image buffer objects) or its parent object (if the memory object is a sub\-buffer or 1D image buffer object) begin execution; otherwise the behavior is undefined\&.
.PP
Accessing the contents of the memory region referred to by the mapped pointer that has been unmapped is undefined\&.
.PP
The mapped pointer returned by
\fBclEnqueueMapBuffer\fR(3clc)
or
\fBclEnqueueMapImage\fR(3clc)
can be used as
\fIptr\fR
argument value to
\fBclEnqueueReadBuffer\fR(3clc),
\fBclEnqueueWriteBuffer\fR(3clc),
\fBclEnqueueReadBufferRect\fR(3clc),
\fBclEnqueueWriteBufferRect\fR(3clc),
\fBclEnqueueReadImage\fR(3clc), and
\fBclEnqueueWriteImage\fR(3clc), provided the rules described above are adhered to\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
returns a valid non\-zero 2D image object and
\fIerrcode_ret\fR
is set to
CL_SUCCESS
if the 2D image object is created successfully\&. Otherwise, it returns a NULL value with one of the following error values returned in
\fIerrcode_ret\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if \fIcontext\fR is not
a valid context\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if values specified in
\fIflags\fR are not valid or if plane is not a valid plane of
\fIresource\fR specified in \fIsurface_info\fR\&.\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_DX9_MEDIA_SURFACE_KHR if
\fIresource\fR specified in \fIsurface_info\fR is not
a valid resource or is not associated with \fIadapter_type\fR (e\&.g\&.,
\fIadapter_type\fR is set to \fBCL_ADAPTER_D3D9_KHR\fR
and \fIresource\fR is not a Direct3D 9 surface created in
\fBD3DPOOL_DEFAULT\fR)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_DX9_MEDIA_SURFACE_KHR if
\fIshared_handle\fR specified in \fIsurface_info\fR
is not NULL or a valid handle value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if the texture format
of \fIresource\fR is not listed in tables 9\&.10\&.3 and 9\&.10\&.4\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_OPERATION if there are no devices in
\fIcontext\fR that support \fIadapter_type\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBcl_khr_dx9_media_sharing\fR(3clc),
\fBclGetDeviceIDsFromDX9MediaAdapterKHR\fR(3clc),
\fBclEnqueueAcquireDX9MediaSurfacesKHR\fR(3clc),
\fBclEnqueueReleaseDX9MediaSurfacesKHR\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 89, section 9.10.7.2 Creating Media Resources as OpenCL Image Objects
.RE