Compute Library
 21.05
CLCoreRuntimeContext.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CLCORERUNTIME_CONTEXT_H
25 #define ARM_COMPUTE_CLCORERUNTIME_CONTEXT_H
26 
28 
29 namespace arm_compute
30 {
31 // Forward declarations
32 class CLKernelLibrary;
33 
34 /** Core runtime context for OpenCL */
36 {
37 public:
38  /** Legacy constructor */
40 
41  /** Constructor */
42  CLCoreRuntimeContext(CLKernelLibrary *kernel_lib, cl::Context ctx, cl::CommandQueue queue);
43  /** Destructor */
44  ~CLCoreRuntimeContext() = default;
45  /** Default copy constructor */
46  CLCoreRuntimeContext(const CLCoreRuntimeContext &) = default;
47  /** Default move constructor */
49  /** Default copy assignment */
51  /** Default move assignment operator */
53  /** Kernel Library accessor
54  *
55  * @return The kernel library instance used by the core context
56  */
58  /** OpenCL context accessor
59  *
60  * @return The OpenCL context used by the core context
61  */
62  cl::Context context();
63  /** OpenCL command queue accessor
64  *
65  * @return The OpenCL queue used by the core context
66  */
67  cl::CommandQueue queue();
68 
69 private:
70  CLKernelLibrary *_kernel_lib{ nullptr };
71  cl::Context _ctx{};
72  cl::CommandQueue _queue{};
73 };
74 } // namespace arm_compute
75 #endif /*ARM_COMPUTE_CLCORERUNTIME_CONTEXT_H */
cl::Context context()
OpenCL context accessor.
cl::CommandQueue queue()
OpenCL command queue accessor.
Copyright (c) 2017-2021 Arm Limited.
Core runtime context for OpenCL.
~CLCoreRuntimeContext()=default
Destructor.
CLCoreRuntimeContext & operator=(const CLCoreRuntimeContext &)=default
Default copy assignment.
CLKernelLibrary * kernel_library() const
Kernel Library accessor.
Wrapper to configure the Khronos OpenCL C++ header.
CLKernelLibrary class.