'\" t
.\"     Title: cl_khr_d3d11_sharing
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CL_KHR_D3D11_SHARING" "3clc" "01/14/2021" "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"
cl_khr_d3d11_sharing \- Provide interoperability between OpenCL and Direct3D 11\&.
.SS ""
.TS
tab(:);
l.
T{
#pragma OPENCL EXTENSION cl_khr_d3d11_sharing : enable
T}
.TE
.sp 1
.SH "DESCRIPTION"
.PP
The goal of this extension is to provide interoperability between OpenCL and Direct3D 11\&. This is designed to function analogously to the
\fBcl_khr_gl_sharing\fR(3clc)
as defined in sections 9\&.7 and 9\&.8\&. If this extension is supported by an implementation, the string "cl_khr_d3d11_sharing" 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
The interfaces for this extension are provided in the header file
cl_d3d11\&.h\&.
.PP
If the
\fBcl_khr_d3d11_sharing\fR
extension is supported, then the following functions are enabled:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclGetDeviceIDsFromD3D11KHR\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclCreateFromD3D11BufferKHR\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclCreateFromD3D11Texture2DKHR\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclCreateFromD3D11Texture3DKHR\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclEnqueueAcquireD3D11ObjectsKHR\fR(3clc).RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBclEnqueueReleaseD3D11ObjectsKHR\fR(3clc).RE
.PP
The OpenCL functions enabled by the
\fBcl_khr_d3d11_sharing\fR
extension 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\&.
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBEXTENSION\fR(3clc),
\fBclGetDeviceIDsFromD3D11KHR\fR(3clc),
\fBclCreateFromD3D11BufferKHR\fR(3clc),
\fBclCreateFromD3D11Texture2DKHR\fR(3clc),
\fBclCreateFromD3D11Texture3DKHR\fR(3clc),
\fBclEnqueueAcquireD3D10ObjectsKHR\fR(3clc),
\fBclEnqueueReleaseD3D11ObjectsKHR\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 97, section 9.11 - Sharing Memory Objects with Direct3D 11
.RE