CLENQUEUERELEASED3D1(3clc)

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

CLENQUEUERELEASED3D1(3clc) 💅

okay so bestie, welcome to the OpenCL Manual, and today's main character is clEnqueueReleaseD3D10ObjectsKHR. yes the name is a whole mouthful, we love her anyway. 🎀

✨ NAME ✨

clEnqueueReleaseD3D10ObjectsKHR — release OpenCL memory objects that have been created from Direct3D 10 resources. that's it, that's the gig. 🦋

✨ SYNOPSIS ✨

cl_int clEnqueueReleaseD3D10ObjectsKHR(cl_command_queue command_queue,
                                       cl_uint num_objects,
                                       const cl_mem *mem_objects,
                                       cl_uint num_events_in_wait_list,
                                       const cl_event *event_wait_list,
                                       cl_event *event);

✨ PARAMETERS ✨

  • num_objects — how many memory objects you're releasing in mem_objects. count them, bestie, the API is trusting you. 🔢
  • mem_objects — a pointer to a list of OpenCL memory objects that were created from Direct3D 10 resources. iykyk. 🫶
  • num_events_in_wait_list, event_wait_list — these two are a package deal, they specify the events that need to complete before this particular command can even be executed.
    • if event_wait_list is NULL, then this particular command does not wait on any event to complete. and heads up: if event_wait_list is NULL, num_events_in_wait_list must be 0. no exceptions. 💀
    • if event_wait_list is not NULL, the list of events pointed to by event_wait_list must be valid, and num_events_in_wait_list must be greater than 0.
    • the events specified in event returns an event object that identifies this particular command and can be used to query or queue a wait for this particular command to complete.
    • event can be NULL, in which case it will not be possible for the application to query the status of this command or queue a wait for this command to complete. lowkey tragic but valid.
    • if the event_wait_list and the event arguments are not NULL, the event argument should not refer to an element of the event_wait_list array. don't do it. 🙈

✨ NOTES ✨

the Direct3D 10 objects are released by the OpenCL context associated with command_queue. that's the vibe. 🌸

OpenCL memory objects created from Direct3D 10 resources which have been acquired by OpenCL must be released by OpenCL before they may be accessed by Direct3D 10. accessing a Direct3D 10 resource while its corresponding OpenCL memory object is acquired is in error and will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination. so like, do not. seriously. 😭

if CL_CONTEXT_INTEROP_USER_SYNC is not specified as CL_TRUE during context creation, clEnqueueReleaseD3D10ObjectsKHR provides the synchronization guarantee that any calls to Direct3D 10 calls involving the interop device(s) used in the OpenCL context made after the call to clEnqueueReleaseD3D10ObjectsKHR will not start executing until after all events in event_wait_list are complete and all work already submitted to command_queue completes execution. if the context was created with properties specifying CL_CONTEXT_INTEROP_USER_SYNC as CL_TRUE, the user is responsible for guaranteeing that any Direct3D 10 calls involving the interop device(s) used in the OpenCL context made after clEnqueueReleaseD3D10ObjectsKHR will not start executing until after event returned by clEnqueueReleaseD3D10ObjectsKHR reports completion. okay so basically: if you opted into user sync, the sync is on you. 👑

general information about sharing memory objects with Direct3D 10 follows. 📚

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). ⭐

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.

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. 🚨

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. ref counting, the original main character. 🧚

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. 💀

✨ ERRORS ✨

returns CL_SUCCESS returns CL_SUCCESS if the function is executed successfully. yes it literally says it twice, that's just how the spec is, we respect her. 💖

if num_objects is 0 and mem_objects is NULL then the function does nothing and returns CL_SUCCESS. otherwise it returns one of the following errors:

  • CL_INVALID_VALUE — if num_objects is zero and mem_objects is not a NULL value, or if num_objects > 0 and mem_objects is NULL. pick a lane bestie. 😤
  • CL_INVALID_MEM_OBJECT — if memory objects in mem_objects are not valid OpenCL memory objects, or if memory objects in mem_objects have not been created from Direct3D 10 resources.
  • CL_INVALID_COMMAND_QUEUE — if command_queue is not a valid command-queue. 🚫
  • CL_INVALID_CONTEXT — if context associated with command_queue was not created from an Direct3D 10 context.
  • CL_D3D10_RESOURCE_NOT_ACQUIRED_KHR — if memory objects in mem_objects have not previously been acquired using clEnqueueAcquireD3D10ObjectsKHR, or have been released using clEnqueueReleaseD3D10ObjectsKHR since the last time that they were acquired. you can't release what you never acquired, that's not how this works. 🎀
  • CL_INVALID_EVENT_WAIT_LIST — if event_wait_list is NULL and num_event_in_wait_list > 0, or event_wait_list is not NULL and num_event_in_wait_list is 0, or if event objects in event_wait_list are not valid events.
  • 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_d3d10_sharing(3clc), clGetDeviceIDsFromD3D10KHR(3clc), clCreateFromD3D10BufferKHR(3clc), clCreateFromD3D10Texture2DKHR(3clc), clCreateFromD3D10Texture3DKHR(3clc), clEnqueueAcquireD3D10ObjectsKHR(3clc)

the whole squad, go read them, no cap. 🫶

✨ 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 79, section 9.9.7.6 - Sharing memory objects created from...

okay that's the whole page bestie, you ate. this was CLENQUEUERELEASED3D1(3clc) from The Khronos Group, dated 01/14/2021, part of the OpenCL Manual — go forth and release your D3D10 objects responsibly, periodt. 💅✨🎀🦋

📦 where this page comes from