summaryrefslogtreecommitdiffstats
path: root/src/opencl/qclcontext.h
blob: 94cd983518b6d2fa5c5d4de35e1b3a138a70c3ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtOpenCL module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QCLCONTEXT_H
#define QCLCONTEXT_H

#include "qcldevice.h"
#include "qclcommandqueue.h"
#include "qclbuffer.h"
#include "qclvector.h"
#include "qclimage.h"
#include "qclsampler.h"
#include "qclprogram.h"
#include <QtCore/qscopedpointer.h>
#include <QtCore/qsize.h>
#include <QtCore/qbytearray.h>
#include <QtCore/qstring.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(CL)

class QCLContextPrivate;
class QCLKernel;
class QCLVectorBase;

class Q_CL_EXPORT QCLContext
{
public:
    QCLContext();
    virtual ~QCLContext();

    bool isCreated() const;

    bool create(QCLDevice::DeviceTypes type = QCLDevice::Default);
    bool create(const QList<QCLDevice> &devices);
    virtual void release();

    cl_context contextId() const;
    void setContextId(cl_context id);

    QList<QCLDevice> devices() const;
    QCLDevice defaultDevice() const;

    cl_int lastError() const;
    void setLastError(cl_int error);

    static QString errorName(cl_int code);

    QCLCommandQueue commandQueue();
    void setCommandQueue(const QCLCommandQueue &queue);

    QCLCommandQueue defaultCommandQueue();
    QCLCommandQueue createCommandQueue
        (cl_command_queue_properties properties,
         const QCLDevice &device = QCLDevice());

    QCLBuffer createBufferDevice
        (size_t size, QCLMemoryObject::Access access);
    QCLBuffer createBufferHost
        (void *data, size_t size, QCLMemoryObject::Access access);
    QCLBuffer createBufferCopy
        (const void *data, size_t size, QCLMemoryObject::Access access);

    template <typename T>
    QCLVector<T> createVector(int size, QCLMemoryObject::Access access = QCLMemoryObject::ReadWrite);

    QCLImage2D createImage2DDevice
        (const QCLImageFormat &format, const QSize &size, QCLMemoryObject::Access access);
    QCLImage2D createImage2DHost
        (const QCLImageFormat &format, void *data, const QSize &size,
         QCLMemoryObject::Access access, int bytesPerLine = 0);
    QCLImage2D createImage2DHost(QImage *image, QCLMemoryObject::Access access);
    QCLImage2D createImage2DCopy
        (const QCLImageFormat &format, const void *data, const QSize &size,
         QCLMemoryObject::Access access, int bytesPerLine = 0);
    QCLImage2D createImage2DCopy
        (const QImage &image, QCLMemoryObject::Access access);

    QCLImage3D createImage3DDevice
        (const QCLImageFormat &format, int width, int height, int depth,
         QCLMemoryObject::Access access);
    QCLImage3D createImage3DHost
        (const QCLImageFormat &format, void *data,
         int width, int height, int depth, QCLMemoryObject::Access access,
         int bytesPerLine = 0, int bytesPerSlice = 0);
    QCLImage3D createImage3DCopy
        (const QCLImageFormat &format, const void *data,
         int width, int height, int depth, QCLMemoryObject::Access access,
         int bytesPerLine = 0, int bytesPerSlice = 0);

    QCLProgram createProgramFromSourceCode(const QByteArray &sourceCode);
    QCLProgram createProgramFromSourceFile(const QString &fileName);
    QCLProgram createProgramFromBinaryCode(const QByteArray &binary);
    QCLProgram createProgramFromBinaryFile(const QString &fileName);
    QCLProgram createProgramFromBinaries
        (const QList<QCLDevice> &devices, const QList<QByteArray> &binaries);

    QCLProgram buildProgramFromSourceCode(const QByteArray &sourceCode);
    QCLProgram buildProgramFromSourceFile(const QString &fileName);
    QCLProgram buildProgramFromBinaryCode(const QByteArray &binary);
    QCLProgram buildProgramFromBinaryFile(const QString &fileName);
    QCLProgram buildProgramFromBinaries
        (const QList<QCLDevice> &devices, const QList<QByteArray> &binaries);

    QList<QCLImageFormat> supportedImage2DFormats(cl_mem_flags flags) const;
    QList<QCLImageFormat> supportedImage3DFormats(cl_mem_flags flags) const;

    void flush();
    void finish();

    QCLEvent marker();

    void sync();

    void barrier();
    void barrier(const QCLEventList &events);

protected:
    void setDefaultDevice(const QCLDevice &device);

private:
    QScopedPointer<QCLContextPrivate> d_ptr;

    Q_DISABLE_COPY(QCLContext)
    Q_DECLARE_PRIVATE(QCLContext)

    cl_command_queue activeQueue(); // For quicker access from friends.

    friend class QCLMemoryObject;
    friend class QCLBuffer;
    friend class QCLImage2D;
    friend class QCLImage3D;
    friend class QCLKernel;
    friend class QCLCommandQueue;
    friend class QCLProgram;
    friend class QCLVectorBase;
    friend class QCLSampler;

    void reportError(const char *name, cl_int error);
};

template <typename T>
Q_INLINE_TEMPLATE QCLVector<T> QCLContext::createVector
    (int size, QCLMemoryObject::Access access)
{
    Q_ASSERT(size >= 1);
    return QCLVector<T>(this, size, access);
}

QT_END_NAMESPACE

QT_END_HEADER

#endif