'\" t
.\"     Title: clEnqueueReleaseD3D11ObjectsKHR
.\"    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 "CLENQUEUERELEASED3D1" "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"
clEnqueueReleaseD3D11ObjectsKHR \- Release OpenCL memory objects that have been created from Direct3D 11 resources\&.
.SH ""
.HP \w'cl_int\ clEnqueueReleaseD3D11ObjectsKHR('u
.BI "cl_int clEnqueueReleaseD3D11ObjectsKHR(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" ");"
.SH "PARAMETERS"
.PP
\fInum_objects\fR
.RS 4
The number of memory objects to be released in
\fImem_objects\fR\&.
.RE
.PP
\fImem_objects\fR
.RS 4
A pointer to a list of OpenCL memory objects that were created from Direct3D 11 resources\&.
.RE
.PP
\fInum_events_in_wait_list\fR, \fIevent_wait_list\fR
.RS 4
Specify events that need to complete before this particular command can be executed\&. If
\fIevent_wait_list\fR
is NULL, then this particular command does not wait on any event to complete\&. If
\fIevent_wait_list\fR
is NULL,
\fInum_events_in_wait_list\fR
must be 0\&. If
\fIevent_wait_list\fR
is not NULL, the list of events pointed to by
\fIevent_wait_list\fR
must be valid and
\fInum_events_in_wait_list\fR
must be greater than 0\&. The events specified in
\fIevent\fR
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\&.
\fIevent\fR
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
\fIevent_wait_list\fR
and the event arguments are not NULL, the
\fIevent\fR
argument should not refer to an element of the
\fIevent_wait_list\fR
array
.RE
.SH "NOTES"
.PP
The Direct3D 11 objects are released by the OpenCL context associated with
\fIcommand_queue\fR\&.
.PP
OpenCL memory objects created from Direct3D 11 resources which have been acquired by OpenCL must be released by OpenCL before they may be accessed by Direct3D 11\&. Accessing a Direct3D 11 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\&.
.PP
If
\fBCL_CONTEXT_INTEROP_USER_SYNC\fR
is not specified as
\fBCL_TRUE\fR
during context creation,
\fBclEnqueueReleaseD3D11ObjectsKHR\fR
provides the synchronization guarantee that any calls to Direct3D 11 calls involving the interop device(s) used in the OpenCL context made after the call to
\fBclEnqueueReleaseD3D11ObjectsKHR\fR
will not start executing until after all events in
\fIevent_wait_list\fR
are complete and all work already submitted to
\fIcommand_queue\fR
completes execution\&. If the context was created with properties specifying
\fBCL_CONTEXT_INTEROP_USER_SYNC\fR
as
\fBCL_TRUE\fR, the user is responsible for guaranteeing that any Direct3D 11 calls involving the interop device(s) used in the OpenCL context made after
\fBclEnqueueReleaseD3D11ObjectsKHR\fR
will not start executing until after event returned by
\fBclEnqueueReleaseD3D11ObjectsKHR\fR
reports completion\&.
.PP
General information about sharing memory objects with Direct3D 11 follows\&.
.PP
The goal of this extension is to provide interoperability between OpenCL and Direct3D 11\&. This is designed to function analogously to the OpenGL interoperability\&. If this extension is supported by an implementation, the string
\fBcl_khr_d3d11_sharing\fR(3clc)
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_d3d11\&.h\&.
.PP
This section discusses OpenCL functions that allow applications to use Direct3D 11 resources as OpenCL memory objects\&. This allows efficient sharing of data between OpenCL and Direct3D 11\&. The OpenCL API may be used to execute kernels that read and/or write memory objects that are also Direct3D 11 resources\&. An OpenCL image object may be created from a Direct3D 11 texture resource\&. An OpenCL buffer object may be created from a Direct3D 11 buffer resource\&. OpenCL memory objects may be created from Direct3D 11 objects if and only if the OpenCL context has been created from a Direct3D 11 device\&.
.PP
An OpenCL memory object created from a Direct3D 11 resource remains valid as long as the corresponding Direct3D 11 resource has not been deleted\&. If the Direct3D 11 resource is deleted through the Direct3D 11 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\&.
.PP
The successful creation of a cl_context against a Direct3D 11 device specified via the context create parameter
\fBCL_CONTEXT_D3D11_DEVICE_KHR\fR
will increment the internal Direct3D reference count on the specified Direct3D 11 device\&. The internal Direct3D reference count on that Direct3D 11 device will be decremented when the OpenCL reference count on the returned OpenCL context drops to zero\&.
.PP
The OpenCL context and corresponding command\-queues are dependent on the existence of the Direct3D 11 device from which the OpenCL context was created\&. If the Direct3D 11 device is deleted through the Direct3D 11 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\&.
.PP
Properties of Direct3D 11 objects may be queried using
\fBclGetMemObjectInfo\fR(3clc)
and
\fBclGetImageInfo\fR(3clc)
with
\fIparam_name\fR
\fBCL_MEM_D3D11_RESOURCE_KHR\fR
and
\fBCL_IMAGE_D3D11_SUBRESOURCE_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
returns
CL_SUCCESS
if the function is executed successfully\&. If
\fInum_objects\fR
is 0 and
\fImem_objects\fR
is NULL then the function does nothing and returns
CL_SUCCESS\&. 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_VALUE if \fInum_objects\fR
is zero and \fImem_objects\fR is not a NULL value or if
\fInum_objects\fR > 0 and \fImem_objects\fR is NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_MEM_OBJECT if memory objects in
\fImem_objects\fR are not valid OpenCL memory objects or if memory
objects in \fImem_objects\fR have not been created from Direct3D
11 resources\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_COMMAND_QUEUE if \fIcommand_queue\fR
is not a valid command\-queue\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if context associated with
\fIcommand_queue\fR was not created from a Direct3D 11 context\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_D3D11_RESOURCE_NOT_ACQUIRED_KHR if memory objects
in \fImem_objects\fR have not previously been acquired using
\fBclEnqueueAcquireD3D11ObjectsKHR\fR, or have been released using
\fBclEnqueueReleaseD3D11ObjectsKHR\fR since the last time that
they were acquired\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_EVENT_WAIT_LIST
if \fIevent_wait_list\fR is NULL and
\fInum_event_in_wait_list\fR > 0,
or \fIevent_wait_list\fR is  not NULL and
\fInum_event_in_wait_list\fR is 0, or if event objects in
\fIevent_wait_list\fR are not valid events\&.
.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_d3d11_sharing\fR(3clc),
\fBclGetDeviceIDsFromD3D11KHR\fR(3clc),
\fBclCreateFromD3D11BufferKHR\fR(3clc),
\fBclCreateFromD3D11Texture2DKHR\fR(3clc),
\fBclCreateFromD3D11Texture3DKHR\fR(3clc),
\fBclEnqueueAcquireD3D11ObjectsKHR\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 110, section 9.11.7.6 - Sharing memory objects created from Direct3D 11...
.RE