CLGETDEVICEIDSFROMD3(3clc)

📦
version 1.0~svn33624 · 3 versions
, in ubuntu jammy, ubuntu noble

💖 CLGETDEVICEIDSFROMD3 — the 3clc page, bestie edition 💖

okay so this is the OpenCL manual page for clGetDeviceIDsFromD3D10KHR, and yes the vibes are Windows-graphics-interop coded but the facts are FACTS and we're keeping every single one 💅

✨ NAME ✨

clGetDeviceIDsFromD3D10KHR — asking which OpenCL devices line up with which Direct3D 10 devices, fr fr 🎀

✨ SYNOPSIS ✨

cl_int clGetDeviceIDsFromD3D10KHR(cl_platform_id platform,
                                  cl_d3d10_device_source_khr d3d_device_source,
                                  void *d3d_object,
                                  cl_d3d10_device_set_khr d3d_device_set,
                                  cl_uint num_entries,
                                  cl_device_id *devices,
                                  cl_uint *num_devices);

🌸 PARAMETERS 🌸

  • platform — the platform ID you got back from clGetPlatformIDs(3clc). That one. Yeah that one. 🫶
  • d3d_device_source — tells everyone what kind of thing d3d_object actually is. It's one of these two, no in-between:
    • CL_D3D10_DEVICE_KHR — the type of d3d_object is ID3D10Device *
    • CL_D3D10_DXGI_ADAPTER_KHR — the type of d3d_object is IDXGIAdapter *
  • d3d_object — the actual object you're asking about, like "which OpenCL devices go with this". The type of d3d_object must be exactly what the table up there says. no substitutions bestie 😭
  • d3d_device_set — which set of devices you want handed back. Gotta be one of these two:
    • CL_PREFERRED_DEVICES_FOR_D3D10_KHR — what comes back in devices is the OpenCL devices associated with the specified Direct3D object. ✨
    • CL_ALL_DEVICES_FOR_D3D10_KHR — what comes back in devices is all OpenCL devices which may interoperate with the specified Direct3D object. heads up tho: performance of sharing data on these devices may be considerably less than on the preferred devices. lowkey a downgrade, highkey still valid 💀
  • num_entries — how many cl_device_id entries can be added to devices. And if devices is not NULL, num_entries must be greater than zero. periodt.
  • devices — returns a list of OpenCL devices that were found. The cl_device_id values returned in devices can be used to identify a specific OpenCL device. If devices is NULL, this argument is ignored, it's giving "not invited to the party" 🙈. The number of OpenCL devices returned is the mininum of the value specified by num_entries and the number of OpenCL devices corresponding to d3d_object. (yes "mininum", that's the original spelling, we don't fix, we preserve 👑)
  • num_devices — returns the number of OpenCL devices available that correspond to d3d_object. If num_devices is NULL, this argument is ignored. same energy. 🦋

🌈 DESCRIPTION 🌈

So basically: the OpenCL devices corresponding to a Direct3D 10 device may be queried. The OpenCL devices corresponding to a DXGI adapter may also be queried. And here's the cute little hierarchy tea — the OpenCL devices corresponding to a Direct3D 10 device will be a subset of the OpenCL devices corresponding to the DXGI adapter against which the Direct3D 10 device was created. it's giving nested friend groups 💜

🧚 NOTES 🧚

General info about sharing memory objects with Direct3D 10 goes like this:

The goal of this extension is to provide interoperability between OpenCL and Direct3D 10. This is designed to function analogously to the OpenGL interoperability. If this extension is supported by an implementation, the string "cl_khr_d3d10_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). like a little name badge at the function party 🎀

As currently proposed, the interfaces for this extension would be provided in cl_d3d10.h.

This section discusses OpenCL functions that allow applications to use Direct3D 10 resources as OpenCL memory objects. This allows efficient sharing of data between OpenCL and Direct3D 10. The OpenCL API may be used to execute kernels that read and/or write memory objects that are also Direct3D 10 resources. An OpenCL image object may be created from a Direct3D 10 texture resource. An OpenCL buffer object may be created from a Direct3D 10 buffer resource. OpenCL memory objects may be created from Direct3D 10 objects if and only if the OpenCL context has been created from a Direct3D 10 device.

Lifetime of Shared Objects.PP — an OpenCL memory object created from a Direct3D 10 resource remains valid as long as the corresponding Direct3D 10 resource has not been deleted. If the Direct3D 10 resource is deleted through the Direct3D 10 API, subsequent use of the OpenCL memory object will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination.

⚠️ bestie that is NOT a drill. undefined behavior means anything can happen. delete the D3D10 resource and then touch the OpenCL memory object? 💀 possible errors, corrupted data, program just ending. do not.

The successful creation of a cl_context against a Direct3D 10 device specified via the context create parameter CL_CONTEXT_D3D10_DEVICE_KHR will increment the internal Direct3D reference count on the specified Direct3D 10 device. The internal Direct3D reference count on that Direct3D 10 device will be decremented when the OpenCL reference count on the returned OpenCL context drops to zero. refcount girlies rise up 🔥

The OpenCL context and corresponding command-queues are dependent on the existence of the Direct3D 10 device from which the OpenCL context was created. If the Direct3D 10 device is deleted through the Direct3D 10 API, subsequent use of the OpenCL context will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination.

⚠️ again!! delete the device, keep using the context → undefined behavior. not a cute look. 🙈

💀 ERRORS 💀

Returns CL_SUCCESS if the function is executed successfully. Otherwise it may return:

  • CL_INVALID_PLATFORM if platform is not a valid platform.
  • CL_INVALID_VALUE if d3d_device_source is not a valid value, d3d_device_set is not a valid value, 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 d3d_object were found.

⭐ SPECIFICATION ⭐

OpenCL Specification[1]

👑 SEE ALSO 👑

cl_khr_d3d10_sharing(3clc), clCreateFromD3D10BufferKHR(3clc), clCreateFromD3D10Texture2DKHR(3clc), clCreateFromD3D10Texture3DKHR(3clc), clEnqueueAcquireD3D10ObjectsKHR(3clc), clEnqueueReleaseD3D10ObjectsKHR(3clc)

go read those too, they're the rest of the friend group 🌸

🫶 AUTHORS 🫶

The Khronos Group

Copyright © 2007-2011 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.

🎀 NOTES 🎀

  1. OpenCL Specification page 71, section 9.9.7.1 - Querying OpenCL Devices Corresponding to... 11...

and that's the whole page, no cap 💅 huge thanks to The Khronos Group for writing it (the 3clc manual, dated 01/14/2021) — we just gave it a makeover and kept every single fact exactly where it was. slay, go forth and query your devices ✨🦋

📦 where this page comes from