e08ba1bf815c2725839f99631a882d19218128bd
[mesa.git] / src / util / xmlpool / t_options.h
1 /*
2 * XML DRI client-side driver configuration
3 * Copyright (C) 2003 Felix Kuehling
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * FELIX KUEHLING, OR ANY OTHER CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
21 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 *
23 */
24 /**
25 * \file t_options.h
26 * \brief Templates of common options
27 * \author Felix Kuehling
28 *
29 * This file defines macros for common options that can be used to
30 * construct driConfigOptions in the drivers. This file is only a
31 * template containing English descriptions for options wrapped in
32 * gettext(). xgettext can be used to extract translatable
33 * strings. These strings can then be translated by anyone familiar
34 * with GNU gettext. gen_xmlpool.py takes this template and fills in
35 * all the translations. The result (options.h) is included by
36 * xmlpool.h which in turn can be included by drivers.
37 *
38 * The macros used to describe options in this file are defined in
39 * src/util/xmlpool.h.
40 */
41
42 /* This is needed for xgettext to extract translatable strings.
43 * gen_xmlpool.py will discard this line. */
44 #include <libintl.h>
45
46 /*
47 * predefined option sections and options with multi-lingual descriptions
48 */
49
50
51 /**
52 * \brief Debugging options
53 */
54 #define DRI_CONF_SECTION_DEBUG \
55 DRI_CONF_SECTION_BEGIN \
56 DRI_CONF_DESC(en,gettext("Debugging"))
57
58 #define DRI_CONF_ALWAYS_FLUSH_BATCH(def) \
59 DRI_CONF_OPT_BEGIN_B(always_flush_batch, def) \
60 DRI_CONF_DESC(en,gettext("Enable flushing batchbuffer after each draw call")) \
61 DRI_CONF_OPT_END
62
63 #define DRI_CONF_ALWAYS_FLUSH_CACHE(def) \
64 DRI_CONF_OPT_BEGIN_B(always_flush_cache, def) \
65 DRI_CONF_DESC(en,gettext("Enable flushing GPU caches with each draw call")) \
66 DRI_CONF_OPT_END
67
68 #define DRI_CONF_DISABLE_THROTTLING(def) \
69 DRI_CONF_OPT_BEGIN_B(disable_throttling, def) \
70 DRI_CONF_DESC(en,gettext("Disable throttling on first batch after flush")) \
71 DRI_CONF_OPT_END
72
73 #define DRI_CONF_FORCE_GLSL_EXTENSIONS_WARN(def) \
74 DRI_CONF_OPT_BEGIN_B(force_glsl_extensions_warn, def) \
75 DRI_CONF_DESC(en,gettext("Force GLSL extension default behavior to 'warn'")) \
76 DRI_CONF_OPT_END
77
78 #define DRI_CONF_DISABLE_BLEND_FUNC_EXTENDED(def) \
79 DRI_CONF_OPT_BEGIN_B(disable_blend_func_extended, def) \
80 DRI_CONF_DESC(en,gettext("Disable dual source blending")) \
81 DRI_CONF_OPT_END
82
83 #define DRI_CONF_DUAL_COLOR_BLEND_BY_LOCATION(def) \
84 DRI_CONF_OPT_BEGIN_B(dual_color_blend_by_location, def) \
85 DRI_CONF_DESC(en,gettext("Identify dual color blending sources by location rather than index")) \
86 DRI_CONF_OPT_END
87
88 #define DRI_CONF_DISABLE_GLSL_LINE_CONTINUATIONS(def) \
89 DRI_CONF_OPT_BEGIN_B(disable_glsl_line_continuations, def) \
90 DRI_CONF_DESC(en,gettext("Disable backslash-based line continuations in GLSL source")) \
91 DRI_CONF_OPT_END
92
93 #define DRI_CONF_FORCE_GLSL_VERSION(def) \
94 DRI_CONF_OPT_BEGIN_V(force_glsl_version, int, def, "0:999") \
95 DRI_CONF_DESC(en,gettext("Force a default GLSL version for shaders that lack an explicit #version line")) \
96 DRI_CONF_OPT_END
97
98 #define DRI_CONF_ALLOW_GLSL_EXTENSION_DIRECTIVE_MIDSHADER(def) \
99 DRI_CONF_OPT_BEGIN_B(allow_glsl_extension_directive_midshader, def) \
100 DRI_CONF_DESC(en,gettext("Allow GLSL #extension directives in the middle of shaders")) \
101 DRI_CONF_OPT_END
102
103 #define DRI_CONF_ALLOW_GLSL_BUILTIN_CONST_EXPRESSION(def) \
104 DRI_CONF_OPT_BEGIN_B(allow_glsl_builtin_const_expression, def) \
105 DRI_CONF_DESC(en,gettext("Allow builtins as part of constant expressions")) \
106 DRI_CONF_OPT_END
107
108 #define DRI_CONF_ALLOW_GLSL_RELAXED_ES(def) \
109 DRI_CONF_OPT_BEGIN_B(allow_glsl_relaxed_es, def) \
110 DRI_CONF_DESC(en,gettext("Allow some relaxation of GLSL ES shader restrictions")) \
111 DRI_CONF_OPT_END
112
113 #define DRI_CONF_ALLOW_GLSL_BUILTIN_VARIABLE_REDECLARATION(def) \
114 DRI_CONF_OPT_BEGIN_B(allow_glsl_builtin_variable_redeclaration, def) \
115 DRI_CONF_DESC(en,gettext("Allow GLSL built-in variables to be redeclared verbatim")) \
116 DRI_CONF_OPT_END
117
118 #define DRI_CONF_ALLOW_HIGHER_COMPAT_VERSION(def) \
119 DRI_CONF_OPT_BEGIN_B(allow_higher_compat_version, def) \
120 DRI_CONF_DESC(en,gettext("Allow a higher compat profile (version 3.1+) for apps that request it")) \
121 DRI_CONF_OPT_END
122
123 #define DRI_CONF_FORCE_GLSL_ABS_SQRT(def) \
124 DRI_CONF_OPT_BEGIN_B(force_glsl_abs_sqrt, def) \
125 DRI_CONF_DESC(en,gettext("Force computing the absolute value for sqrt() and inversesqrt()")) \
126 DRI_CONF_OPT_END
127
128 #define DRI_CONF_GLSL_CORRECT_DERIVATIVES_AFTER_DISCARD(def) \
129 DRI_CONF_OPT_BEGIN_B(glsl_correct_derivatives_after_discard, def) \
130 DRI_CONF_DESC(en,gettext("Implicit and explicit derivatives after a discard behave as if the discard didn't happen")) \
131 DRI_CONF_OPT_END
132
133 #define DRI_CONF_ALLOW_GLSL_CROSS_STAGE_INTERPOLATION_MISMATCH(def) \
134 DRI_CONF_OPT_BEGIN_B(allow_glsl_cross_stage_interpolation_mismatch, def) \
135 DRI_CONF_DESC(en,gettext("Allow interpolation qualifier mismatch across shader stages")) \
136 DRI_CONF_OPT_END
137
138 #define DRI_CONF_ALLOW_GLSL_LAYOUT_QUALIFIER_ON_FUNCTION_PARAMETERS(def) \
139 DRI_CONF_OPT_BEGIN_B(allow_glsl_layout_qualifier_on_function_parameters, def) \
140 DRI_CONF_DESC(en,gettext("Allow layout qualifiers on function parameters.")) \
141 DRI_CONF_OPT_END
142
143 #define DRI_CONF_FORCE_GL_VENDOR(def) \
144 DRI_CONF_OPT_BEGIN(force_gl_vendor, string, def) \
145 DRI_CONF_DESC(en,gettext("Allow GPU vendor to be overridden.")) \
146 DRI_CONF_OPT_END
147
148 #define DRI_CONF_FORCE_COMPAT_PROFILE(def) \
149 DRI_CONF_OPT_BEGIN_B(force_compat_profile, def) \
150 DRI_CONF_DESC(en,gettext("Force an OpenGL compatibility context")) \
151 DRI_CONF_OPT_END
152
153 /**
154 * \brief Image quality-related options
155 */
156 #define DRI_CONF_SECTION_QUALITY \
157 DRI_CONF_SECTION_BEGIN \
158 DRI_CONF_DESC(en,gettext("Image Quality"))
159
160 #define DRI_CONF_PRECISE_TRIG(def) \
161 DRI_CONF_OPT_BEGIN_B(precise_trig, def) \
162 DRI_CONF_DESC(en,gettext("Prefer accuracy over performance in trig functions")) \
163 DRI_CONF_OPT_END
164
165 #define DRI_CONF_PP_CELSHADE(def) \
166 DRI_CONF_OPT_BEGIN_V(pp_celshade,enum,def,"0:1") \
167 DRI_CONF_DESC(en,gettext("A post-processing filter to cel-shade the output")) \
168 DRI_CONF_OPT_END
169
170 #define DRI_CONF_PP_NORED(def) \
171 DRI_CONF_OPT_BEGIN_V(pp_nored,enum,def,"0:1") \
172 DRI_CONF_DESC(en,gettext("A post-processing filter to remove the red channel")) \
173 DRI_CONF_OPT_END
174
175 #define DRI_CONF_PP_NOGREEN(def) \
176 DRI_CONF_OPT_BEGIN_V(pp_nogreen,enum,def,"0:1") \
177 DRI_CONF_DESC(en,gettext("A post-processing filter to remove the green channel")) \
178 DRI_CONF_OPT_END
179
180 #define DRI_CONF_PP_NOBLUE(def) \
181 DRI_CONF_OPT_BEGIN_V(pp_noblue,enum,def,"0:1") \
182 DRI_CONF_DESC(en,gettext("A post-processing filter to remove the blue channel")) \
183 DRI_CONF_OPT_END
184
185 #define DRI_CONF_PP_JIMENEZMLAA(def,min,max) \
186 DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa,int,def, # min ":" # max ) \
187 DRI_CONF_DESC(en,gettext("Morphological anti-aliasing based on Jimenez\\\' MLAA. 0 to disable, 8 for default quality")) \
188 DRI_CONF_OPT_END
189
190 #define DRI_CONF_PP_JIMENEZMLAA_COLOR(def,min,max) \
191 DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa_color,int,def, # min ":" # max ) \
192 DRI_CONF_DESC(en,gettext("Morphological anti-aliasing based on Jimenez\\\' MLAA. 0 to disable, 8 for default quality. Color version, usable with 2d GL apps")) \
193 DRI_CONF_OPT_END
194
195
196
197 /**
198 * \brief Performance-related options
199 */
200 #define DRI_CONF_SECTION_PERFORMANCE \
201 DRI_CONF_SECTION_BEGIN \
202 DRI_CONF_DESC(en,gettext("Performance"))
203
204 #define DRI_CONF_VBLANK_NEVER 0
205 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
206 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
207 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
208 #define DRI_CONF_VBLANK_MODE(def) \
209 DRI_CONF_OPT_BEGIN_V(vblank_mode,enum,def,"0:3") \
210 DRI_CONF_DESC_BEGIN(en,gettext("Synchronization with vertical refresh (swap intervals)")) \
211 DRI_CONF_ENUM(0,gettext("Never synchronize with vertical refresh, ignore application's choice")) \
212 DRI_CONF_ENUM(1,gettext("Initial swap interval 0, obey application's choice")) \
213 DRI_CONF_ENUM(2,gettext("Initial swap interval 1, obey application's choice")) \
214 DRI_CONF_ENUM(3,gettext("Always synchronize with vertical refresh, application chooses the minimum swap interval")) \
215 DRI_CONF_DESC_END \
216 DRI_CONF_OPT_END
217
218 #define DRI_CONF_ADAPTIVE_SYNC(def) \
219 DRI_CONF_OPT_BEGIN_B(adaptive_sync,def) \
220 DRI_CONF_DESC(en,gettext("Adapt the monitor sync to the application performance (when possible)")) \
221 DRI_CONF_OPT_END
222
223 #define DRI_CONF_VK_X11_OVERRIDE_MIN_IMAGE_COUNT(def) \
224 DRI_CONF_OPT_BEGIN_V(vk_x11_override_min_image_count, int, def, "0:999") \
225 DRI_CONF_DESC(en,gettext("Override the VkSurfaceCapabilitiesKHR::minImageCount (0 = no override)")) \
226 DRI_CONF_OPT_END
227
228 #define DRI_CONF_VK_X11_STRICT_IMAGE_COUNT(def) \
229 DRI_CONF_OPT_BEGIN_B(vk_x11_strict_image_count, def) \
230 DRI_CONF_DESC(en,gettext("Force the X11 WSI to create exactly the number of image specified by the application in VkSwapchainCreateInfoKHR::minImageCount")) \
231 DRI_CONF_OPT_END
232
233 #define DRI_CONF_MESA_GLTHREAD(def) \
234 DRI_CONF_OPT_BEGIN_B(mesa_glthread, def) \
235 DRI_CONF_DESC(en,gettext("Enable offloading GL driver work to a separate thread")) \
236 DRI_CONF_OPT_END
237
238 #define DRI_CONF_MESA_NO_ERROR(def) \
239 DRI_CONF_OPT_BEGIN_B(mesa_no_error, def) \
240 DRI_CONF_DESC(en,gettext("Disable GL driver error checking")) \
241 DRI_CONF_OPT_END
242
243 #define DRI_CONF_DISABLE_EXT_BUFFER_AGE(def) \
244 DRI_CONF_OPT_BEGIN_B(glx_disable_ext_buffer_age, def) \
245 DRI_CONF_DESC(en, gettext("Disable the GLX_EXT_buffer_age extension")) \
246 DRI_CONF_OPT_END
247
248 #define DRI_CONF_DISABLE_OML_SYNC_CONTROL(def) \
249 DRI_CONF_OPT_BEGIN_B(glx_disable_oml_sync_control, def) \
250 DRI_CONF_DESC(en, gettext("Disable the GLX_OML_sync_control extension")) \
251 DRI_CONF_OPT_END
252
253 #define DRI_CONF_DISABLE_SGI_VIDEO_SYNC(def) \
254 DRI_CONF_OPT_BEGIN_B(glx_disable_sgi_video_sync, def) \
255 DRI_CONF_DESC(en, gettext("Disable the GLX_SGI_video_sync extension")) \
256 DRI_CONF_OPT_END
257
258
259
260 /**
261 * \brief Miscellaneous configuration options
262 */
263 #define DRI_CONF_SECTION_MISCELLANEOUS \
264 DRI_CONF_SECTION_BEGIN \
265 DRI_CONF_DESC(en,gettext("Miscellaneous"))
266
267 #define DRI_CONF_ALWAYS_HAVE_DEPTH_BUFFER(def) \
268 DRI_CONF_OPT_BEGIN_B(always_have_depth_buffer, def) \
269 DRI_CONF_DESC(en,gettext("Create all visuals with a depth buffer")) \
270 DRI_CONF_OPT_END
271
272 #define DRI_CONF_GLSL_ZERO_INIT(def) \
273 DRI_CONF_OPT_BEGIN_B(glsl_zero_init, def) \
274 DRI_CONF_DESC(en,gettext("Force uninitialized variables to default to zero")) \
275 DRI_CONF_OPT_END
276
277 #define DRI_CONF_ALLOW_RGB10_CONFIGS(def) \
278 DRI_CONF_OPT_BEGIN_B(allow_rgb10_configs, def) \
279 DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with rgb10a2 formats")) \
280 DRI_CONF_OPT_END
281
282 #define DRI_CONF_ALLOW_RGB565_CONFIGS(def) \
283 DRI_CONF_OPT_BEGIN_B(allow_rgb565_configs, def) \
284 DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with rgb565 formats")) \
285 DRI_CONF_OPT_END
286
287 #define DRI_CONF_ALLOW_FP16_CONFIGS(def) \
288 DRI_CONF_OPT_BEGIN_B(allow_fp16_configs, def) \
289 DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with fp16 formats")) \
290 DRI_CONF_OPT_END
291
292 /**
293 * \brief Initialization configuration options
294 */
295 #define DRI_CONF_SECTION_INITIALIZATION \
296 DRI_CONF_SECTION_BEGIN \
297 DRI_CONF_DESC(en,gettext("Initialization"))
298
299 #define DRI_CONF_DEVICE_ID_PATH_TAG(def) \
300 DRI_CONF_OPT_BEGIN(device_id, string, def) \
301 DRI_CONF_DESC(en,gettext("Define the graphic device to use if possible")) \
302 DRI_CONF_OPT_END
303
304 #define DRI_CONF_DRI_DRIVER(def) \
305 DRI_CONF_OPT_BEGIN(dri_driver, string, def) \
306 DRI_CONF_DESC(en,gettext("Override the DRI driver to load")) \
307 DRI_CONF_OPT_END
308
309 /**
310 * \brief Gallium-Nine specific configuration options
311 */
312
313 #define DRI_CONF_SECTION_NINE \
314 DRI_CONF_SECTION_BEGIN \
315 DRI_CONF_DESC(en,gettext("Gallium Nine"))
316
317 #define DRI_CONF_NINE_THROTTLE(def) \
318 DRI_CONF_OPT_BEGIN(throttle_value, int, def) \
319 DRI_CONF_DESC(en,gettext("Define the throttling value. -1 for no throttling, -2 for default (usually 2), 0 for glfinish behaviour")) \
320 DRI_CONF_OPT_END
321
322 #define DRI_CONF_NINE_THREADSUBMIT(def) \
323 DRI_CONF_OPT_BEGIN_B(thread_submit, def) \
324 DRI_CONF_DESC(en,gettext("Use an additional thread to submit buffers.")) \
325 DRI_CONF_OPT_END
326
327 #define DRI_CONF_NINE_OVERRIDEVENDOR(def) \
328 DRI_CONF_OPT_BEGIN(override_vendorid, int, def) \
329 DRI_CONF_DESC(en,gettext("Define the vendor_id to report. This allows faking another hardware vendor.")) \
330 DRI_CONF_OPT_END
331
332 #define DRI_CONF_NINE_ALLOWDISCARDDELAYEDRELEASE(def) \
333 DRI_CONF_OPT_BEGIN_B(discard_delayed_release, def) \
334 DRI_CONF_DESC(en,gettext("Whether to allow the display server to release buffers with a delay when using d3d's presentation mode DISCARD. Default to true. Set to false if suffering from lag (thread_submit=true can also help in this situation).")) \
335 DRI_CONF_OPT_END
336
337 #define DRI_CONF_NINE_TEARFREEDISCARD(def) \
338 DRI_CONF_OPT_BEGIN_B(tearfree_discard, def) \
339 DRI_CONF_DESC(en,gettext("Whether to make d3d's presentation mode DISCARD (games usually use that mode) Tear Free. If rendering above screen refresh, some frames will get skipped. false by default.")) \
340 DRI_CONF_OPT_END
341
342 #define DRI_CONF_NINE_CSMT(def) \
343 DRI_CONF_OPT_BEGIN(csmt_force, int, def) \
344 DRI_CONF_DESC(en,gettext("If set to 1, force gallium nine CSMT. If set to 0, disable it. By default (-1) CSMT is enabled on known thread-safe drivers.")) \
345 DRI_CONF_OPT_END
346
347 #define DRI_CONF_NINE_DYNAMICTEXTUREWORKAROUND(def) \
348 DRI_CONF_OPT_BEGIN_B(dynamic_texture_workaround, def) \
349 DRI_CONF_DESC(en,gettext("If set to true, use a ram intermediate buffer for dynamic textures. Increases ram usage, which can cause out of memory issues, but can fix glitches for some games.")) \
350 DRI_CONF_OPT_END
351
352 #define DRI_CONF_NINE_SHADERINLINECONSTANTS(def) \
353 DRI_CONF_OPT_BEGIN_B(shader_inline_constants, def) \
354 DRI_CONF_DESC(en,gettext("If set to true, recompile shaders with integer or boolean constants when the values are known. Can cause stutter, but can increase slightly performance.")) \
355 DRI_CONF_OPT_END
356
357 /**
358 * \brief radeonsi specific configuration options
359 */
360
361 #define DRI_CONF_RADEONSI_ENABLE_SISCHED(def) \
362 DRI_CONF_OPT_BEGIN_B(radeonsi_enable_sisched, def) \
363 DRI_CONF_DESC(en,gettext("Use the LLVM sisched option for shader compiles")) \
364 DRI_CONF_OPT_END
365
366 #define DRI_CONF_RADEONSI_ASSUME_NO_Z_FIGHTS(def) \
367 DRI_CONF_OPT_BEGIN_B(radeonsi_assume_no_z_fights, def) \
368 DRI_CONF_DESC(en,gettext("Assume no Z fights (enables aggressive out-of-order rasterization to improve performance; may cause rendering errors)")) \
369 DRI_CONF_OPT_END
370
371 #define DRI_CONF_RADEONSI_COMMUTATIVE_BLEND_ADD(def) \
372 DRI_CONF_OPT_BEGIN_B(radeonsi_commutative_blend_add, def) \
373 DRI_CONF_DESC(en,gettext("Commutative additive blending optimizations (may cause rendering errors)")) \
374 DRI_CONF_OPT_END
375
376 #define DRI_CONF_RADEONSI_ZERO_ALL_VRAM_ALLOCS(def) \
377 DRI_CONF_OPT_BEGIN_B(radeonsi_zerovram, def) \
378 DRI_CONF_DESC(en,"Zero all vram allocations") \
379 DRI_CONF_OPT_END
380
381 #define DRI_CONF_V3D_NONMSAA_TEXTURE_SIZE_LIMIT(def) \
382 DRI_CONF_OPT_BEGIN_B(v3d_nonmsaa_texture_size_limit, def) \
383 DRI_CONF_DESC(en,"Report the non-MSAA-only texture size limit") \
384 DRI_CONF_OPT_END
385
386 /**
387 * \brief virgl specific configuration options
388 */
389
390 #define DRI_CONF_GLES_EMULATE_BGRA(def) \
391 DRI_CONF_OPT_BEGIN_B(gles_emulate_bgra, def) \
392 DRI_CONF_DESC(en,gettext("On GLES emulate BGRA formats by using a swizzled RGBA format")) \
393 DRI_CONF_OPT_END
394
395 #define DRI_CONF_GLES_APPLY_BGRA_DEST_SWIZZLE(def) \
396 DRI_CONF_OPT_BEGIN_B(gles_apply_bgra_dest_swizzle, def) \
397 DRI_CONF_DESC(en,gettext("When the BGRA formats are emulated by using swizzled RGBA formats on GLES apply the swizzle when writing")) \
398 DRI_CONF_OPT_END
399
400 #define DRI_CONF_GLES_SAMPLES_PASSED_VALUE(def, minimum, maximum) \
401 DRI_CONF_OPT_BEGIN_V(gles_samples_passed_value, def, minimum, maximum) \
402 DRI_CONF_DESC(en,gettext("GL_SAMPLES_PASSED value when emulated by GL_ANY_SAMPLES_PASSED")) \
403 DRI_CONF_OPT_END