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
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
/*!
\class QCLWorkSize
\brief The QCLWorkSize class defines the size of an item of work for an OpenCL kernel.
\since 4.7
\ingroup opencl
OpenCL work sizes may be single-dimensional, two-dimensional,
or three-dimensional:
\code
QCLWorkSize oned(128);
QCLWorkSize twod(16, 16);
QCLWorkSize threed(32, 32, 16);
...
QCLKernel kernel = ...;
kernel.setGlobalWorkSize(oned);
kernel.setGlobalWorkSize(twod);
kernel.setGlobalWorkSize(threed);
\endcode
For convenience, QCLKernel::setGlobalWorkSize() and
QCLKernel::setLocalWorkSize() can be specified by a QCLWorkSize
object or direct numeric arguments:
\code
QCLKernel kernel = ...;
kernel.setGlobalWorkSize(128);
kernel.setGlobalWorkSize(16, 16);
kernel.setGlobalWorkSize(32, 32, 16);
\endcode
\sa QCLKernel
*/
/*!
\fn QCLWorkSize::QCLWorkSize()
Constructs a default work size consisting of a single dimension
with width() set to 1.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t size)
Constructs a single-dimensional work size with width() set to \a size.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t width, size_t height)
Constructs a two-dimensional work size of \a width x \a height.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(const QSize &size)
Constructs a two-dimensional work size set to \a size.
*/
/*!
\fn QCLWorkSize::QCLWorkSize(size_t width, size_t height, size_t depth)
Constructs a three-dimensional work size of \a width x \a height x
\a depth.
*/
/*!
\fn size_t QCLWorkSize::dimensions() const
Returns the number of dimensions for this work size, 1, 2, or 3.
*/
/*!
\fn size_t QCLWorkSize::width() const
Returns the width of this work size specification.
*/
/*!
\fn size_t QCLWorkSize::height() const
Returns the height of this work size specification.
*/
/*!
\fn size_t QCLWorkSize::depth() const
Returns the depth of this work size specification.
*/
/*!
\fn const size_t *QCLWorkSize::sizes() const
Returns a const pointer to the size array within this object.
*/
/*!
\fn bool QCLWorkSize::operator==(const QCLWorkSize &other) const
Returns true if this work size specification has the same
dimensions as \a other; false otherwise.
\sa operator!=()
*/
/*!
\fn bool QCLWorkSize::operator!=(const QCLWorkSize &other) const
Returns true if this work size specification does not have
the same dimensions as \a other; false otherwise.
\sa operator==()
*/
|
