CLDeviceContext.h

Go to the documentation of this file.

/********************************************************************
 **                Image Component Library (ICL)                    **
 **                                                                 **
 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
 **                         Neuroinformatics Group                  **
 ** Website: www.iclcv.org and                                      **
 **          http://opensource.cit-ec.de/projects/icl               **
 **                                                                 **
 ** File   : ICLUtils/src/ICLUtils/CLDeviceContext.h                **
 ** Module : ICLUtils                                               **
 ** Authors: Tobias Roehlig                                         **
 **                                                                 **
 **                                                                 **
 ** GNU LESSER GENERAL PUBLIC LICENSE                               **
 ** This file may be used under the terms of the GNU Lesser General **
 ** Public License version 3.0 as published by the                  **
 **                                                                 **
 ** Free Software Foundation and appearing in the file LICENSE.GPL  **
 ** included in the packaging of this file.  Please review the      **
 ** following information to ensure the license requirements will   **
 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
 **                                                                 **
 ** The development of this software was supported by the           **
 ** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
 ** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
 ** Forschungsgemeinschaft (DFG) in the context of the German       **
 ** Excellence Initiative.                                          **
 **                                                                 **
 ********************************************************************/

#pragma once

#ifdef ICL_HAVE_OPENCL

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/CLBuffer.h>
#include <ICLUtils/CLKernel.h>
#include <ICLUtils/CLImage2D.h>
#include <ICLUtils/CLException.h>
#include <string>


namespace cl{
  class Device;
  class CommandQueue;
  class Context;
}

namespace icl {
        namespace utils {

                class ICLUtils_API CLDeviceContext {
                        struct Impl;
                        Impl *impl;

                        cl::Device &getDevice();
                        cl::CommandQueue &getCommandQueue();
                        cl::Context &getContext();

                public:

                        friend class CLProgram; 
                        friend class CLMemoryAssistant; 

                        CLDeviceContext() ;
                        CLDeviceContext(std::string const &device) ;
                        CLDeviceContext(const CLDeviceContext &other);
                        CLDeviceContext const &operator=(CLDeviceContext const& other);
                        ~CLDeviceContext();

                        //accessMode = "r" only read
                        //accessMode = "w" only write
                        //accessMode = "rw" read and write
                        CLBuffer createBuffer(const string &accessMode, size_t size, const void *src=0) ;

                        CLBuffer createBuffer(const string &accessMode, size_t length, size_t byteDepth, const void *src = 0) ;

                        CLImage2D createImage2D(const string &accessMode, const size_t width, const size_t height, int depth, const void *src=0) ;

                        CLImage2D createImage2D(const string &accessMode, const size_t width, const size_t height, int depth, int num_channel, const void *src=0) ;

                        std::string const getDeviceTypeString();
                        std::string const getDeviceTypeString() const;

                        void listSelectedPlatform();

                        void listSelectedDevice();

                        static void listAllPlatformsAndDevices();

                        static void listAllPlatforms();

                private:

                        CLBuffer *createBufferHeap(const string &accessMode, size_t length, size_t byteDepth, const void *src=0) ;

                        CLImage2D *createImage2DHeap(const string &accessMode, const size_t width, const size_t height, int depth, int num_channel, const void *src=0) ;
                };

        }
}

#endif