blob: f3b11f8b75db6e443bf14ae5890813bfcad297e8 [file] [log] [blame]
Pablo Tellob7c308a2019-01-22 12:59:26 +00001/*
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_CL_HELPERS_H__
25#define __ARM_COMPUTE_CL_HELPERS_H__
26
27#include "arm_compute/core/CL/OpenCL.h"
28
29namespace arm_compute
30{
31/** This function creates an OpenCL context and a device.
32 *
33 * @note In debug builds, the function will automatically enable cl_arm_printf if the driver/device supports it.
34 *
35 * @return A std::tuple where the first element is the opencl context, the second element is the opencl device
36 * and the third one an error code. The error code will be CL_SUCCESS upon successful creation, otherwise
37 * a value telling why the function failed.
38 */
39std::tuple<cl::Context, cl::Device, cl_int> create_opencl_context_and_device();
40} // namespace arm_compute
41#endif /* __ARM_COMPUTE_CL_HELPERS_H__ */