aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/cpufeatures-module.qdoc
blob: 8dcd117f1a8ab76d7077f65bc7536758645f78fe (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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \contentspage index.html
    \qmltype cpufeatures
    \inqmlmodule QbsModules
    \since Qbs 1.10

    \brief Provides support for fine-tuning CPU features.

    The \c cpufeatures module offers properties for enabling or disabling specific CPU features.
    Use it if you want to override the compiler defaults for a given platform.

    The compiler rules in the \l{cpp} module evaluate this module's properties
    and generate matching compiler flags.
    All properties in this module are of type \c bool and have the following semantics:
    \list
    \li The default value \c undefined has no effect on the compiler command line.
    \li If the value is \c true and the compiler has a flag to enable the feature, that flag
        is added to the command line if it is applicable to the current architecture.
        For example, enabling the property \c x86_sse2 would result in the GCC option \c{-msse2}.
    \li If the value is \c false and the compiler has a flag to disable the feature,
        that flag is added to the command line if it is applicable to the current architecture.
        For example, disabling the property \c x86_sse2 would result in the GCC option
        \c{-no-msse2}.
    \endlist
*/

/*!
    \qmlproperty bool cpufeatures::arm_neon

    Whether to use NEON instructions in ARM binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::arm_vfpv4

    Whether to use VFPv4 instructions in ARM binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::mips_dsp

    Whether to use DSP instructions in MIPS binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::mips_dspr2

    Whether to use DSPr2 instructions in MIPS binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx

    Whether to use AVX instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx2

    Whether to use AVX2 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512bw

    Whether to use AVX-512-BW instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512cd

    Whether to use AVX-512-CD instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512dq

    Whether to use AVX-512-DQ instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512er

    Whether to use AVX-512-ER instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512f

    Whether to use AVX-512 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512ifma

    Whether to use AVX-512-IFMA instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512pf

    Whether to use AVX-512-PF instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512vbmi

    Whether to use AVX-512-VBMI instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_avx512vl

    Whether to use AVX-512-VL instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_f16c

    Whether to use F16C instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_sse2

    Whether to use SSE2 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_sse3

    Whether to use SSE3 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_ssse3

    Whether to use SSSE3 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_sse4_1

    Whether to use SSE4.1 instructions in x86 binaries.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool cpufeatures::x86_sse4_2

    Whether to use SSE4.2 instructions in x86 binaries.

    \nodefaultvalue
*/