'\" t
.\"     Title: clGetDeviceIDsFromDX9MediaAdapterKHR
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETDEVICEIDSFROMDX" "3clc" "02/03/2019" "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"
clGetDeviceIDsFromDX9MediaAdapterKHR \- Query a media adapter for any associated OpenCL devices\&.
.SH ""
.HP \w'cl_int\ clGetDeviceIDsFromDX9MediaAdapterKHR('u
.BI "cl_int clGetDeviceIDsFromDX9MediaAdapterKHR(cl_platform_id\ " "platform" ", cl_uint\ " "num_media_adapters" ", cl_dx9_media_adapter_type_khr\ *" "media_adapters_type" ", void\ *" "media_adapters" ", cl_dx9_media_adapter_set_khr\ " "media_adapter_set" ", cl_uint\ " "num_entries" ", cl_device_id\ *" "devices" ", cl_int\ *" "num_devices" ");"
.SH "PARAMETERS"
.PP
\fIplatform\fR
.RS 4
Refers to the platform ID returned by
\fBclGetPlatformIDs\fR(3clc)\&.
.RE
.PP
\fInum_media_adapters\fR
.RS 4
The number of media adapters\&.
.RE
.PP
\fImedia_adapters_type\fR
.RS 4
An array of
\fInum_media_adapters\fR
entries\&. Each entry specifies the type of media adapter and must be one of the values described in the table below\&.
.TS
allbox tab(:);
lB lB.
T{
cl_dx9_media_adapter_type_khr
T}:T{
Type of media adapters
T}
.T&
l l
l l
l l.
T{
\fBCL_ADAPTER_D3D9_KHR\fR
T}:T{
IDirect3DDevice9 *
T}
T{
\fBCL_ADAPTER_D3D9EX_KHR\fR
T}:T{
IDirect3DDevice9Ex *
T}
T{
\fBCL_ADAPTER_DXVA_KHR\fR
T}:T{
IDXVAHD_Device *
T}
.TE
.sp 1
.RE
.PP
\fImedia_adapters\fR
.RS 4
An array of
\fInum_media_adapters\fR
entries\&. Each entry specifies the actual adapter whose type is specified by
\fImedia_adapter_type\fR\&. The
\fImedia_adapters\fR
must be one of the types describes in the table above\&.
.RE
.PP
\fImedia_adapter_set\fR
.RS 4
Specifies the set of adapters to return and must be one of the values described in the table below\&.
.TS
allbox tab(:);
lB lB.
T{
cl_dx9_media_adapter_set_khr
T}:T{
Description
T}
.T&
l l
l l.
T{
\fBCL_PREFERRED_DEVICES_FOR_MEDIA_ADAPTER_KHR\fR
T}:T{
The preferred OpenCL devices associated with the media adapter\&.
T}
T{
\fBCL_ALL_DEVICES_FOR_MEDIA_ADAPTER_KHR\fR
T}:T{
All OpenCL devices that may interoperate with the media adapter\&.
T}
.TE
.sp 1
.RE
.PP
\fInum_entries\fR
.RS 4
The number of cl_device_id entries that can be added to
\fIdevices\fR\&. If
\fIdevices\fR
is not NULL, the
\fInum_entries\fR
must be greater than zero\&.
.RE
.PP
\fIdevices\fR
.RS 4
Returns a list of OpenCL devices found that support the list of media adapters specified\&. The cl_device_id values returned in
\fIdevices\fR
can be used to identify a specific OpenCL device\&. If
\fIdevices\fR
argument is NULL, this argument is ignored\&. The number of OpenCL devices returned is the minimum of the value specified by
\fInum_entries\fR
or the number of OpenCL devices whose type matches
\fIdevice_type\fR\&.
.RE
.PP
\fInum_devices\fR
.RS 4
Returns the number of OpenCL devices\&. If
\fInum_devices\fR
is NULL, this argument is ignored\&.
.RE
.SH "DESCRIPTION"
.PP
Queries a media adapter for any associated OpenCL devices\&. Adapters with associated OpenCL devices can enable media surface sharing between the two\&.
.SH "NOTES"
.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
if the function is executed successfully\&. Otherwise, it returns one of the following errors:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_PLATFORM if \fIplatform\fR is not
a valid platform\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fInum_media_adapters\fR
is zero or if \fImedia_adapters_type\fR is NULL or if
\fImedia_adapters\fR is NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if any of the entries in
\fImedia_adapters_type\fR or \fImedia_adapters\fR
is not a valid value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fImedia_adapter_set\fR
is not a valid value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fInum_entries\fR
is equal to zero and \fIdevices\fR is not NULL or if both
\fInum_devices\fR and \fIdevices\fR are NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_DEVICE_NOT_FOUND if no OpenCL devices that
correspond to adapters specified in \fImedia_adapters\fR and
\fImedia_adapters_type\fR were found\&.
.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),
\fBclCreateFromDX9MediaSurfaceKHR\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 88, section 9.10.7.1 - Querying OpenCL Devices corresponding....
.RE