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 otions in this file are defined in
39 * ../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 \
55DRI_CONF_SECTION_BEGIN \
56        DRI_CONF_DESC(en,gettext("Debugging"))
57
58#define DRI_CONF_ALWAYS_FLUSH_BATCH(def) \
59DRI_CONF_OPT_BEGIN_B(always_flush_batch, def) \
60        DRI_CONF_DESC(en,gettext("Enable flushing batchbuffer after each draw call")) \
61DRI_CONF_OPT_END
62
63#define DRI_CONF_ALWAYS_FLUSH_CACHE(def) \
64DRI_CONF_OPT_BEGIN_B(always_flush_cache, def) \
65        DRI_CONF_DESC(en,gettext("Enable flushing GPU caches with each draw call")) \
66DRI_CONF_OPT_END
67
68#define DRI_CONF_DISABLE_THROTTLING(def) \
69DRI_CONF_OPT_BEGIN_B(disable_throttling, def) \
70        DRI_CONF_DESC(en,gettext("Disable throttling on first batch after flush")) \
71DRI_CONF_OPT_END
72
73#define DRI_CONF_FORCE_GLSL_EXTENSIONS_WARN(def) \
74DRI_CONF_OPT_BEGIN_B(force_glsl_extensions_warn, def) \
75        DRI_CONF_DESC(en,gettext("Force GLSL extension default behavior to 'warn'")) \
76DRI_CONF_OPT_END
77
78#define DRI_CONF_DISABLE_BLEND_FUNC_EXTENDED(def) \
79DRI_CONF_OPT_BEGIN_B(disable_blend_func_extended, def) \
80        DRI_CONF_DESC(en,gettext("Disable dual source blending")) \
81DRI_CONF_OPT_END
82
83#define DRI_CONF_DUAL_COLOR_BLEND_BY_LOCATION(def) \
84DRI_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")) \
86DRI_CONF_OPT_END
87
88#define DRI_CONF_DISABLE_GLSL_LINE_CONTINUATIONS(def) \
89DRI_CONF_OPT_BEGIN_B(disable_glsl_line_continuations, def) \
90        DRI_CONF_DESC(en,gettext("Disable backslash-based line continuations in GLSL source")) \
91DRI_CONF_OPT_END
92
93#define DRI_CONF_FORCE_GLSL_VERSION(def) \
94DRI_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")) \
96DRI_CONF_OPT_END
97
98#define DRI_CONF_ALLOW_GLSL_EXTENSION_DIRECTIVE_MIDSHADER(def) \
99DRI_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")) \
101DRI_CONF_OPT_END
102
103#define DRI_CONF_ALLOW_GLSL_BUILTIN_CONST_EXPRESSION(def) \
104DRI_CONF_OPT_BEGIN_B(allow_glsl_builtin_const_expression, def) \
105        DRI_CONF_DESC(en,gettext("Allow builtins as part of constant expressions")) \
106DRI_CONF_OPT_END
107
108#define DRI_CONF_ALLOW_GLSL_RELAXED_ES(def) \
109DRI_CONF_OPT_BEGIN_B(allow_glsl_relaxed_es, def) \
110        DRI_CONF_DESC(en,gettext("Allow some relaxation of GLSL ES shader restrictions")) \
111DRI_CONF_OPT_END
112
113#define DRI_CONF_ALLOW_GLSL_BUILTIN_VARIABLE_REDECLARATION(def) \
114DRI_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")) \
116DRI_CONF_OPT_END
117
118#define DRI_CONF_ALLOW_HIGHER_COMPAT_VERSION(def) \
119DRI_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")) \
121DRI_CONF_OPT_END
122
123#define DRI_CONF_FORCE_GLSL_ABS_SQRT(def) \
124DRI_CONF_OPT_BEGIN_B(force_glsl_abs_sqrt, def) \
125        DRI_CONF_DESC(en,gettext("Force computing the absolute value for sqrt() and inversesqrt()")) \
126DRI_CONF_OPT_END
127
128#define DRI_CONF_GLSL_CORRECT_DERIVATIVES_AFTER_DISCARD(def) \
129DRI_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")) \
131DRI_CONF_OPT_END
132
133#define DRI_CONF_ALLOW_GLSL_CROSS_STAGE_INTERPOLATION_MISMATCH(def) \
134DRI_CONF_OPT_BEGIN_B(allow_glsl_cross_stage_interpolation_mismatch, def) \
135        DRI_CONF_DESC(en,gettext("Allow interpolation qualifier mismatch across shader stages")) \
136DRI_CONF_OPT_END
137
138#define DRI_CONF_ALLOW_GLSL_LAYOUT_QUALIFIER_ON_FUNCTION_PARAMETERS(def) \
139DRI_CONF_OPT_BEGIN_B(allow_glsl_layout_qualifier_on_function_parameters, def) \
140        DRI_CONF_DESC(en,gettext("Allow layout qualifiers on function parameters.")) \
141DRI_CONF_OPT_END
142
143#define DRI_CONF_FORCE_COMPAT_PROFILE(def) \
144DRI_CONF_OPT_BEGIN_B(force_compat_profile, def) \
145        DRI_CONF_DESC(en,gettext("Force an OpenGL compatibility context")) \
146DRI_CONF_OPT_END
147
148/**
149 * \brief Image quality-related options
150 */
151#define DRI_CONF_SECTION_QUALITY \
152DRI_CONF_SECTION_BEGIN \
153        DRI_CONF_DESC(en,gettext("Image Quality"))
154
155#define DRI_CONF_PRECISE_TRIG(def) \
156DRI_CONF_OPT_BEGIN_B(precise_trig, def) \
157        DRI_CONF_DESC(en,gettext("Prefer accuracy over performance in trig functions")) \
158DRI_CONF_OPT_END
159
160#define DRI_CONF_PP_CELSHADE(def) \
161DRI_CONF_OPT_BEGIN_V(pp_celshade,enum,def,"0:1") \
162        DRI_CONF_DESC(en,gettext("A post-processing filter to cel-shade the output")) \
163DRI_CONF_OPT_END
164
165#define DRI_CONF_PP_NORED(def) \
166DRI_CONF_OPT_BEGIN_V(pp_nored,enum,def,"0:1") \
167        DRI_CONF_DESC(en,gettext("A post-processing filter to remove the red channel")) \
168DRI_CONF_OPT_END
169
170#define DRI_CONF_PP_NOGREEN(def) \
171DRI_CONF_OPT_BEGIN_V(pp_nogreen,enum,def,"0:1") \
172        DRI_CONF_DESC(en,gettext("A post-processing filter to remove the green channel")) \
173DRI_CONF_OPT_END
174
175#define DRI_CONF_PP_NOBLUE(def) \
176DRI_CONF_OPT_BEGIN_V(pp_noblue,enum,def,"0:1") \
177        DRI_CONF_DESC(en,gettext("A post-processing filter to remove the blue channel")) \
178DRI_CONF_OPT_END
179
180#define DRI_CONF_PP_JIMENEZMLAA(def,min,max) \
181DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa,int,def, # min ":" # max ) \
182        DRI_CONF_DESC(en,gettext("Morphological anti-aliasing based on Jimenez\\\' MLAA. 0 to disable, 8 for default quality")) \
183DRI_CONF_OPT_END
184
185#define DRI_CONF_PP_JIMENEZMLAA_COLOR(def,min,max) \
186DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa_color,int,def, # min ":" # max ) \
187        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")) \
188DRI_CONF_OPT_END
189
190
191
192/**
193 * \brief Performance-related options
194 */
195#define DRI_CONF_SECTION_PERFORMANCE \
196DRI_CONF_SECTION_BEGIN \
197        DRI_CONF_DESC(en,gettext("Performance"))
198
199#define DRI_CONF_VBLANK_NEVER 0
200#define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
201#define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
202#define DRI_CONF_VBLANK_ALWAYS_SYNC 3
203#define DRI_CONF_VBLANK_MODE(def) \
204DRI_CONF_OPT_BEGIN_V(vblank_mode,enum,def,"0:3") \
205        DRI_CONF_DESC_BEGIN(en,gettext("Synchronization with vertical refresh (swap intervals)")) \
206                DRI_CONF_ENUM(0,gettext("Never synchronize with vertical refresh, ignore application's choice")) \
207                DRI_CONF_ENUM(1,gettext("Initial swap interval 0, obey application's choice")) \
208                DRI_CONF_ENUM(2,gettext("Initial swap interval 1, obey application's choice")) \
209                DRI_CONF_ENUM(3,gettext("Always synchronize with vertical refresh, application chooses the minimum swap interval")) \
210        DRI_CONF_DESC_END \
211DRI_CONF_OPT_END
212
213#define DRI_CONF_ADAPTIVE_SYNC(def) \
214DRI_CONF_OPT_BEGIN_B(adaptive_sync,def) \
215        DRI_CONF_DESC(en,gettext("Adapt the monitor sync to the application performance (when possible)")) \
216DRI_CONF_OPT_END
217
218#define DRI_CONF_VK_X11_OVERRIDE_MIN_IMAGE_COUNT(def) \
219DRI_CONF_OPT_BEGIN_V(vk_x11_override_min_image_count, int, def, "0:999") \
220        DRI_CONF_DESC(en,gettext("Override the VkSurfaceCapabilitiesKHR::minImageCount (0 = no override)")) \
221DRI_CONF_OPT_END
222
223#define DRI_CONF_MESA_GLTHREAD(def) \
224DRI_CONF_OPT_BEGIN_B(mesa_glthread, def) \
225        DRI_CONF_DESC(en,gettext("Enable offloading GL driver work to a separate thread")) \
226DRI_CONF_OPT_END
227
228#define DRI_CONF_MESA_NO_ERROR(def) \
229DRI_CONF_OPT_BEGIN_B(mesa_no_error, def) \
230        DRI_CONF_DESC(en,gettext("Disable GL driver error checking")) \
231DRI_CONF_OPT_END
232
233#define DRI_CONF_DISABLE_EXT_BUFFER_AGE(def) \
234DRI_CONF_OPT_BEGIN_B(glx_disable_ext_buffer_age, def) \
235   DRI_CONF_DESC(en, gettext("Disable the GLX_EXT_buffer_age extension")) \
236DRI_CONF_OPT_END
237
238#define DRI_CONF_DISABLE_OML_SYNC_CONTROL(def) \
239DRI_CONF_OPT_BEGIN_B(glx_disable_oml_sync_control, def) \
240   DRI_CONF_DESC(en, gettext("Disable the GLX_OML_sync_control extension")) \
241DRI_CONF_OPT_END
242
243#define DRI_CONF_DISABLE_SGI_VIDEO_SYNC(def) \
244DRI_CONF_OPT_BEGIN_B(glx_disable_sgi_video_sync, def) \
245   DRI_CONF_DESC(en, gettext("Disable the GLX_SGI_video_sync extension")) \
246DRI_CONF_OPT_END
247
248
249
250/**
251 * \brief Miscellaneous configuration options
252 */
253#define DRI_CONF_SECTION_MISCELLANEOUS \
254DRI_CONF_SECTION_BEGIN \
255        DRI_CONF_DESC(en,gettext("Miscellaneous"))
256
257#define DRI_CONF_ALWAYS_HAVE_DEPTH_BUFFER(def) \
258DRI_CONF_OPT_BEGIN_B(always_have_depth_buffer, def) \
259        DRI_CONF_DESC(en,gettext("Create all visuals with a depth buffer")) \
260DRI_CONF_OPT_END
261
262#define DRI_CONF_GLSL_ZERO_INIT(def) \
263DRI_CONF_OPT_BEGIN_B(glsl_zero_init, def) \
264        DRI_CONF_DESC(en,gettext("Force uninitialized variables to default to zero")) \
265DRI_CONF_OPT_END
266
267#define DRI_CONF_ALLOW_RGB10_CONFIGS(def) \
268DRI_CONF_OPT_BEGIN_B(allow_rgb10_configs, def) \
269DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with rgb10a2 formats")) \
270DRI_CONF_OPT_END
271
272#define DRI_CONF_ALLOW_RGB565_CONFIGS(def) \
273DRI_CONF_OPT_BEGIN_B(allow_rgb565_configs, def) \
274DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with rgb565 formats")) \
275DRI_CONF_OPT_END
276
277/**
278 * \brief Initialization configuration options
279 */
280#define DRI_CONF_SECTION_INITIALIZATION \
281DRI_CONF_SECTION_BEGIN \
282        DRI_CONF_DESC(en,gettext("Initialization"))
283
284#define DRI_CONF_DEVICE_ID_PATH_TAG(def) \
285DRI_CONF_OPT_BEGIN(device_id, string, def) \
286        DRI_CONF_DESC(en,gettext("Define the graphic device to use if possible")) \
287DRI_CONF_OPT_END
288
289#define DRI_CONF_DRI_DRIVER(def) \
290DRI_CONF_OPT_BEGIN(dri_driver, string, def) \
291        DRI_CONF_DESC(en,gettext("Override the DRI driver to load")) \
292DRI_CONF_OPT_END
293
294/**
295 * \brief Gallium-Nine specific configuration options
296 */
297
298#define DRI_CONF_SECTION_NINE \
299DRI_CONF_SECTION_BEGIN \
300        DRI_CONF_DESC(en,gettext("Gallium Nine"))
301
302#define DRI_CONF_NINE_THROTTLE(def) \
303DRI_CONF_OPT_BEGIN(throttle_value, int, def) \
304        DRI_CONF_DESC(en,gettext("Define the throttling value. -1 for no throttling, -2 for default (usually 2), 0 for glfinish behaviour")) \
305DRI_CONF_OPT_END
306
307#define DRI_CONF_NINE_THREADSUBMIT(def) \
308DRI_CONF_OPT_BEGIN_B(thread_submit, def) \
309        DRI_CONF_DESC(en,gettext("Use an additional thread to submit buffers.")) \
310DRI_CONF_OPT_END
311
312#define DRI_CONF_NINE_OVERRIDEVENDOR(def) \
313DRI_CONF_OPT_BEGIN(override_vendorid, int, def) \
314        DRI_CONF_DESC(en,gettext("Define the vendor_id to report. This allows faking another hardware vendor.")) \
315DRI_CONF_OPT_END
316
317#define DRI_CONF_NINE_ALLOWDISCARDDELAYEDRELEASE(def) \
318DRI_CONF_OPT_BEGIN_B(discard_delayed_release, def) \
319        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).")) \
320DRI_CONF_OPT_END
321
322#define DRI_CONF_NINE_TEARFREEDISCARD(def) \
323DRI_CONF_OPT_BEGIN_B(tearfree_discard, def) \
324        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.")) \
325DRI_CONF_OPT_END
326
327#define DRI_CONF_NINE_CSMT(def) \
328DRI_CONF_OPT_BEGIN(csmt_force, int, def) \
329        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.")) \
330DRI_CONF_OPT_END
331
332#define DRI_CONF_NINE_DYNAMICTEXTUREWORKAROUND(def) \
333DRI_CONF_OPT_BEGIN_B(dynamic_texture_workaround, def) \
334        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.")) \
335DRI_CONF_OPT_END
336
337#define DRI_CONF_NINE_SHADERINLINECONSTANTS(def) \
338DRI_CONF_OPT_BEGIN_B(shader_inline_constants, def) \
339        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.")) \
340DRI_CONF_OPT_END
341
342/**
343 * \brief radeonsi specific configuration options
344 */
345
346#define DRI_CONF_RADEONSI_ENABLE_SISCHED(def) \
347DRI_CONF_OPT_BEGIN_B(radeonsi_enable_sisched, def) \
348        DRI_CONF_DESC(en,gettext("Use the LLVM sisched option for shader compiles")) \
349DRI_CONF_OPT_END
350
351#define DRI_CONF_RADEONSI_ASSUME_NO_Z_FIGHTS(def) \
352DRI_CONF_OPT_BEGIN_B(radeonsi_assume_no_z_fights, def) \
353        DRI_CONF_DESC(en,gettext("Assume no Z fights (enables aggressive out-of-order rasterization to improve performance; may cause rendering errors)")) \
354DRI_CONF_OPT_END
355
356#define DRI_CONF_RADEONSI_COMMUTATIVE_BLEND_ADD(def) \
357DRI_CONF_OPT_BEGIN_B(radeonsi_commutative_blend_add, def) \
358        DRI_CONF_DESC(en,gettext("Commutative additive blending optimizations (may cause rendering errors)")) \
359DRI_CONF_OPT_END
360
361#define DRI_CONF_RADEONSI_ZERO_ALL_VRAM_ALLOCS(def) \
362DRI_CONF_OPT_BEGIN_B(radeonsi_zerovram, def) \
363        DRI_CONF_DESC(en,"Zero all vram allocations") \
364DRI_CONF_OPT_END
365
366