Ubuntu Manpage: clEnqueueReleaseD3D10ObjectsKHR - Release OpenCL memory objects that have been created from Direct3D 10

Provided by: opencl-1.2-man-doc_1.0~svn33624-1_all

NAME

       clEnqueueReleaseD3D10ObjectsKHR - Release OpenCL memory objects that have been created from Direct3D 10
       resources.

       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
           The number of memory objects to be released in mem_objects.

       mem_objects
           A pointer to a list of OpenCL memory objects that were created from Direct3D 10 resources.

       num_events_in_wait_list, event_wait_list
           Specify events that need to complete before this particular command can be executed. If
           event_wait_list is NULL, then this particular command does not wait on any event to complete. If
           event_wait_list is NULL, num_events_in_wait_list must be 0. 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. 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.

NOTES

The Direct3D 10 objects are released by the OpenCL context associated with command_queue.

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.

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.

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

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.

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

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

       •   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]

AUTHORS

       The Khronos Group

COPYRIGHT

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

NAME

PARAMETERS

NOTES

ERRORS

SPECIFICATION

SEE ALSO

AUTHORS

COPYRIGHT

NOTES