table of contents
CLGETDEVICEIDSFROMDX(3clc) | OpenCL Manual | CLGETDEVICEIDSFROMDX(3clc) |
NAME¶
clGetDeviceIDsFromDX9MediaAdapterKHR - Query a media adapter for any associated OpenCL devices.¶
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);
PARAMETERS¶
platformRefers to the platform ID returned by
clGetPlatformIDs(3clc).
num_media_adapters
The number of media adapters.
media_adapters_type
An array of num_media_adapters entries. Each entry
specifies the type of media adapter and must be one of the values described in
the table below.
media_adapters
cl_dx9_media_adapter_type_khr | Type of media adapters |
CL_ADAPTER_D3D9_KHR | IDirect3DDevice9 * |
CL_ADAPTER_D3D9EX_KHR | IDirect3DDevice9Ex * |
CL_ADAPTER_DXVA_KHR | IDXVAHD_Device * |
An array of num_media_adapters entries. Each entry
specifies the actual adapter whose type is specified by
media_adapter_type. The media_adapters must be one of the types
describes in the table above.
media_adapter_set
Specifies the set of adapters to return and must be one
of the values described in the table below.
num_entries
cl_dx9_media_adapter_set_khr | Description |
CL_PREFERRED_DEVICES_FOR_MEDIA_ADAPTER_KHR | The preferred OpenCL devices associated with the media adapter. |
CL_ALL_DEVICES_FOR_MEDIA_ADAPTER_KHR | All OpenCL devices that may interoperate with the media adapter. |
The number of cl_device_id entries that can be added to
devices. If devices is not NULL, the num_entries must be
greater than zero.
devices
Returns a list of OpenCL devices found that support the
list of media adapters specified. The cl_device_id values returned in
devices can be used to identify a specific OpenCL device. If
devices argument is NULL, this argument is ignored. The number of
OpenCL devices returned is the minimum of the value specified by
num_entries or the number of OpenCL devices whose type matches
device_type.
num_devices
Returns the number of OpenCL devices. If
num_devices is NULL, this argument is ignored.
DESCRIPTION¶
Queries a media adapter for any associated OpenCL devices. Adapters with associated OpenCL devices can enable media surface sharing between the two.NOTES¶
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. If this extension is supported by an implementation, the string "cl_khr_media_sharing" will be present in the CL_PLATFORM_EXTENSIONS or CL_DEVICE_EXTENSIONS string described in the table of allowed values for param_name for clGetDeviceInfo(3clc). As currently proposed the interfaces for this extension would be provided in cl_dx9_media_sharing.h. 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.FOUR CC code | CL image format (channel order, channel data type) |
FOURCC('N', 'V', '1', '2'), Plane 0 | CL_R, CL_UNORM_INT8 |
FOURCC('N', 'V', '1', '2'), Plane 1 | CL_RG, CL_UNORM_INT8 |
FOURCC('Y', 'V', '1', '2'), Plane 0 | CL_R, CL_UNORM_INT8 |
FOURCC('Y', 'V', '1', '2'), Plane 1 | CL_R, CL_UNORM_INT8 |
FOURCC('Y', 'V', '1', '2'), Plane 2 | CL_R, CL_UNORM_INT8 |
D3D format | CL image format (channel order, channel data type) |
D3DFMT_R32F | CL_R, CL_FLOAT |
D3DFMT_R16F | CL_R, CL_HALF_FLOAT |
D3DFMT_L16 | CL_R, CL_UNORM_INT16 |
D3DFMT_A8 | CL_A, CL_UNORM_INT8 |
D3DFMT_L8 | CL_R, CL_UNORM_INT8 |
D3DFMT_G32R32F | CL_RG, CL_FLOAT |
D3DFMT_G16R16F | CL_RG, CL_HALF_FLOAT |
D3DFMT_G16R16 | CL_RG, CL_UNORM_INT16 |
D3DFMT_A8L8 | CL_RG, CL_UNORM_INT8 |
D3DFMT_A32B32G32R32F | CL_RGBA, CL_FLOAT |
D3DFMT_A16B16G16R16F | CL_RGBA, CL_HALF_FLOAT |
D3DFMT_A16B16G16R16 | CL_RGBA, CL_UNORM_INT16 |
D3DFMT_A8B8G8R8 | CL_RGBA, CL_UNORM_INT8 |
D3DFMT_X8B8G8R8 | CL_RGBA, CL_UNORM_INT8 |
D3DFMT_A8R8G8B8 | CL_BGRA, CL_UNORM_INT8 |
D3DFMT_X8R8G8B8 | CL_BGRA, CL_UNORM_INT8 |
ERRORS¶
Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:•CL_INVALID_PLATFORM if platform is not a
valid platform.
•CL_INVALID_VALUE if num_media_adapters is
zero or if media_adapters_type is NULL or if media_adapters is
NULL.
•CL_INVALID_VALUE if any of the entries in
media_adapters_type or media_adapters is not a valid
value.
•CL_INVALID_VALUE if media_adapter_set is
not a valid value.
•CL_INVALID_VALUE if num_entries is equal
to zero and devices is not NULL or if both num_devices and
devices are NULL.
•CL_DEVICE_NOT_FOUND if no OpenCL devices that
correspond to adapters specified in media_adapters and
media_adapters_type were found.
•CL_OUT_OF_RESOURCES if there is a failure to
allocate resources required by the OpenCL implementation on the device.
•CL_OUT_OF_HOST_MEMORY if there is a failure to
allocate resources required by the OpenCL implementation on the host.
SPECIFICATION¶
OpenCL Specification[1]SEE ALSO¶
cl_khr_dx9_media_sharing(3clc), clGetDeviceIDsFromDX9MediaAdapterKHR(3clc), clCreateFromDX9MediaSurfaceKHR(3clc), clEnqueueAcquireDX9MediaSurfacesKHR(3clc), clEnqueueReleaseDX9MediaSurfacesKHR(3clc),AUTHORS¶
The Khronos GroupCOPYRIGHT¶
Copyright © 2007-2011 The Khronos Group Inc.NOTES¶
- 1.
- OpenCL Specification
page 88, section 9.10.7.1 - Querying OpenCL Devices
corresponding....
06/18/2014 | The Khronos Group |