SkelCL.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2011-2012 The SkelCL Team as listed in CREDITS.txt          *
 * http://skelcl.uni-muenster.de                                             *
 *                                                                           *
 * This file is part of SkelCL.                                              *
 * SkelCL is available under multiple licenses.                              *
 * The different licenses are subject to terms and condition as provided     *
 * in the files specifying the license. See "LICENSE.txt" for details        *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * SkelCL is free software: you can redistribute it and/or modify            *
 * it under the terms of the GNU General Public License as published by      *
 * the Free Software Foundation, either version 3 of the License, or         *
 * (at your option) any later version. See "LICENSE-gpl.txt" for details.    *
 *                                                                           *
 * SkelCL 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 General Public License for more details.                              *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * For non-commercial academic use see the license specified in the file     *
 * "LICENSE-academic.txt".                                                   *
 *                                                                           *
 *****************************************************************************
 *                                                                           *
 * If you are interested in other licensing models, including a commercial-  *
 * license, please contact the author at michel.steuwer@uni-muenster.de      *
 *                                                                           *
 *****************************************************************************/




#ifndef SKELCL_H_
#define SKELCL_H_

#include "detail/Device.h"
#include "detail/DeviceID.h"
#include "detail/DeviceProperties.h"
#include "detail/Macros.h"
#include "detail/PlatformID.h"
#include "detail/Types.h"
#include "detail/skelclDll.h"

namespace skelcl {

typedef detail::Device::Type device_type;

SKELCL_DLL detail::DeviceProperties allDevices();

SKELCL_DLL detail::DeviceProperties nDevices(size_t n);

SKELCL_DLL detail::PlatformID platform(size_t pID);

SKELCL_DLL detail::DeviceID device(size_t dID);

SKELCL_DLL void init(detail::DeviceProperties properties = allDevices());

SKELCL_DLL void init(detail::PlatformID pID, detail::DeviceID dID);

SKELCL_DLL void terminate();

} // namespace skelcl

#endif // SKELCL_H_