ccl_platforms.h

Go to the documentation of this file.

/*
 * This file is part of cf4ocl (C Framework for OpenCL).
 *
 * cf4ocl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * cf4ocl is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with cf4ocl. If not, see
 * <http://www.gnu.org/licenses/>.
 * */

#ifndef _CCL_PLATFORMS_H_
#define _CCL_PLATFORMS_H_

#include "ccl_common.h"
#include "ccl_platform_wrapper.h"
#include "ccl_errors.h"

/* Creates a new CCLPlatforms* object, which contains the list
 * of OpenCL platforms available in the system. */
CCL_EXPORT
CCLPlatforms* ccl_platforms_new(CCLErr **err);

/* Destroy a CCLPlatforms* object, including all underlying
 * platforms, devices and data. */
CCL_EXPORT
void ccl_platforms_destroy(CCLPlatforms* platforms);

/* Return number of OpenCL platforms found in CCLPlatforms*
 * object. */
CCL_EXPORT
cl_uint ccl_platforms_count(CCLPlatforms* platforms);

/* Get CCL platform wrapper object at given index. */
CCL_EXPORT
CCLPlatform* ccl_platforms_get(
    CCLPlatforms* platforms, cl_uint index);

#endif