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 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 \
  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_COMPAT_PROFILE(def) \
 144 DRI_CONF_OPT_BEGIN_B(force_compat_profile, def) \
 145         DRI_CONF_DESC(en,gettext("Force an OpenGL compatibility context")) \
 146 DRI_CONF_OPT_END
 147
 148 /**
 149  * \brief Image quality-related options
 150  */
 151 #define DRI_CONF_SECTION_QUALITY \
 152 DRI_CONF_SECTION_BEGIN \
 153         DRI_CONF_DESC(en,gettext("Image Quality"))
 154
 155 #define DRI_CONF_TEXTURE_DEPTH_FB       0
 156 #define DRI_CONF_TEXTURE_DEPTH_32       1
 157 #define DRI_CONF_TEXTURE_DEPTH_16       2
 158 #define DRI_CONF_TEXTURE_DEPTH_FORCE_16 3
 159 #define DRI_CONF_TEXTURE_DEPTH(def) \
 160 DRI_CONF_OPT_BEGIN_V(texture_depth,enum,def,"0:3") \
 161         DRI_CONF_DESC_BEGIN(en,gettext("Texture color depth")) \
 162                 DRI_CONF_ENUM(0,gettext("Prefer frame buffer color depth")) \
 163                 DRI_CONF_ENUM(1,gettext("Prefer 32 bits per texel")) \
 164                 DRI_CONF_ENUM(2,gettext("Prefer 16 bits per texel")) \
 165                 DRI_CONF_ENUM(3,gettext("Force 16 bits per texel")) \
 166         DRI_CONF_DESC_END \
 167 DRI_CONF_OPT_END
 168
 169 #define DRI_CONF_DEF_MAX_ANISOTROPY(def,range) \
 170 DRI_CONF_OPT_BEGIN_V(def_max_anisotropy,float,def,range) \
 171         DRI_CONF_DESC(en,gettext("Initial maximum value for anisotropic texture filtering")) \
 172 DRI_CONF_OPT_END
 173
 174 #define DRI_CONF_NO_NEG_LOD_BIAS(def) \
 175 DRI_CONF_OPT_BEGIN_B(no_neg_lod_bias, def) \
 176         DRI_CONF_DESC(en,gettext("Forbid negative texture LOD bias")) \
 177 DRI_CONF_OPT_END
 178
 179 #define DRI_CONF_PRECISE_TRIG(def) \
 180 DRI_CONF_OPT_BEGIN_B(precise_trig, def) \
 181         DRI_CONF_DESC(en,gettext("Prefer accuracy over performance in trig functions")) \
 182 DRI_CONF_OPT_END
 183
 184 #define DRI_CONF_PP_CELSHADE(def) \
 185 DRI_CONF_OPT_BEGIN_V(pp_celshade,enum,def,"0:1") \
 186         DRI_CONF_DESC(en,gettext("A post-processing filter to cel-shade the output")) \
 187 DRI_CONF_OPT_END
 188
 189 #define DRI_CONF_PP_NORED(def) \
 190 DRI_CONF_OPT_BEGIN_V(pp_nored,enum,def,"0:1") \
 191         DRI_CONF_DESC(en,gettext("A post-processing filter to remove the red channel")) \
 192 DRI_CONF_OPT_END
 193
 194 #define DRI_CONF_PP_NOGREEN(def) \
 195 DRI_CONF_OPT_BEGIN_V(pp_nogreen,enum,def,"0:1") \
 196         DRI_CONF_DESC(en,gettext("A post-processing filter to remove the green channel")) \
 197 DRI_CONF_OPT_END
 198
 199 #define DRI_CONF_PP_NOBLUE(def) \
 200 DRI_CONF_OPT_BEGIN_V(pp_noblue,enum,def,"0:1") \
 201         DRI_CONF_DESC(en,gettext("A post-processing filter to remove the blue channel")) \
 202 DRI_CONF_OPT_END
 203
 204 #define DRI_CONF_PP_JIMENEZMLAA(def,min,max) \
 205 DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa,int,def, # min ":" # max ) \
 206         DRI_CONF_DESC(en,gettext("Morphological anti-aliasing based on Jimenez\\\' MLAA. 0 to disable, 8 for default quality")) \
 207 DRI_CONF_OPT_END
 208
 209 #define DRI_CONF_PP_JIMENEZMLAA_COLOR(def,min,max) \
 210 DRI_CONF_OPT_BEGIN_V(pp_jimenezmlaa_color,int,def, # min ":" # max ) \
 211         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")) \
 212 DRI_CONF_OPT_END
 213
 214
 215
 216 /**
 217  * \brief Performance-related options
 218  */
 219 #define DRI_CONF_SECTION_PERFORMANCE \
 220 DRI_CONF_SECTION_BEGIN \
 221         DRI_CONF_DESC(en,gettext("Performance"))
 222
 223 #define DRI_CONF_FTHROTTLE_BUSY 0
 224 #define DRI_CONF_FTHROTTLE_USLEEPS 1
 225 #define DRI_CONF_FTHROTTLE_IRQS 2
 226 #define DRI_CONF_FTHROTTLE_MODE(def) \
 227 DRI_CONF_OPT_BEGIN_V(fthrottle_mode,enum,def,"0:2") \
 228         DRI_CONF_DESC_BEGIN(en,gettext("Method to limit rendering latency")) \
 229                 DRI_CONF_ENUM(0,gettext("Busy waiting for the graphics hardware")) \
 230                 DRI_CONF_ENUM(1,gettext("Sleep for brief intervals while waiting for the graphics hardware")) \
 231                 DRI_CONF_ENUM(2,gettext("Let the graphics hardware emit a software interrupt and sleep")) \
 232         DRI_CONF_DESC_END \
 233 DRI_CONF_OPT_END
 234
 235 #define DRI_CONF_VBLANK_NEVER 0
 236 #define DRI_CONF_VBLANK_DEF_INTERVAL_0 1
 237 #define DRI_CONF_VBLANK_DEF_INTERVAL_1 2
 238 #define DRI_CONF_VBLANK_ALWAYS_SYNC 3
 239 #define DRI_CONF_VBLANK_MODE(def) \
 240 DRI_CONF_OPT_BEGIN_V(vblank_mode,enum,def,"0:3") \
 241         DRI_CONF_DESC_BEGIN(en,gettext("Synchronization with vertical refresh (swap intervals)")) \
 242                 DRI_CONF_ENUM(0,gettext("Never synchronize with vertical refresh, ignore application's choice")) \
 243                 DRI_CONF_ENUM(1,gettext("Initial swap interval 0, obey application's choice")) \
 244                 DRI_CONF_ENUM(2,gettext("Initial swap interval 1, obey application's choice")) \
 245                 DRI_CONF_ENUM(3,gettext("Always synchronize with vertical refresh, application chooses the minimum swap interval")) \
 246         DRI_CONF_DESC_END \
 247 DRI_CONF_OPT_END
 248
 249 #define DRI_CONF_MESA_GLTHREAD(def) \
 250 DRI_CONF_OPT_BEGIN_B(mesa_glthread, def) \
 251         DRI_CONF_DESC(en,gettext("Enable offloading GL driver work to a separate thread")) \
 252 DRI_CONF_OPT_END
 253
 254 #define DRI_CONF_MESA_NO_ERROR(def) \
 255 DRI_CONF_OPT_BEGIN_B(mesa_no_error, def) \
 256         DRI_CONF_DESC(en,gettext("Disable GL driver error checking")) \
 257 DRI_CONF_OPT_END
 258
 259 #define DRI_CONF_DISABLE_EXT_BUFFER_AGE(def) \
 260 DRI_CONF_OPT_BEGIN_B(glx_disable_ext_buffer_age, def) \
 261    DRI_CONF_DESC(en, gettext("Disable the GLX_EXT_buffer_age extension")) \
 262 DRI_CONF_OPT_END
 263
 264 #define DRI_CONF_DISABLE_OML_SYNC_CONTROL(def) \
 265 DRI_CONF_OPT_BEGIN_B(glx_disable_oml_sync_control, def) \
 266    DRI_CONF_DESC(en, gettext("Disable the GLX_OML_sync_control extension")) \
 267 DRI_CONF_OPT_END
 268
 269 #define DRI_CONF_DISABLE_SGI_VIDEO_SYNC(def) \
 270 DRI_CONF_OPT_BEGIN_B(glx_disable_sgi_video_sync, def) \
 271    DRI_CONF_DESC(en, gettext("Disable the GLX_SGI_video_sync extension")) \
 272 DRI_CONF_OPT_END
 273
 274
 275
 276 /**
 277  * \brief Miscellaneous configuration options
 278  */
 279 #define DRI_CONF_SECTION_MISCELLANEOUS \
 280 DRI_CONF_SECTION_BEGIN \
 281         DRI_CONF_DESC(en,gettext("Miscellaneous"))
 282
 283 #define DRI_CONF_ALWAYS_HAVE_DEPTH_BUFFER(def) \
 284 DRI_CONF_OPT_BEGIN_B(always_have_depth_buffer, def) \
 285         DRI_CONF_DESC(en,gettext("Create all visuals with a depth buffer")) \
 286 DRI_CONF_OPT_END
 287
 288 #define DRI_CONF_GLSL_ZERO_INIT(def) \
 289 DRI_CONF_OPT_BEGIN_B(glsl_zero_init, def) \
 290         DRI_CONF_DESC(en,gettext("Force uninitialized variables to default to zero")) \
 291 DRI_CONF_OPT_END
 292
 293 #define DRI_CONF_ALLOW_RGB10_CONFIGS(def) \
 294 DRI_CONF_OPT_BEGIN_B(allow_rgb10_configs, def) \
 295 DRI_CONF_DESC(en,gettext("Allow exposure of visuals and fbconfigs with rgb10a2 formats")) \
 296 DRI_CONF_OPT_END
 297
 298 /**
 299  * \brief Initialization configuration options
 300  */
 301 #define DRI_CONF_SECTION_INITIALIZATION \
 302 DRI_CONF_SECTION_BEGIN \
 303         DRI_CONF_DESC(en,gettext("Initialization"))
 304
 305 #define DRI_CONF_DEVICE_ID_PATH_TAG(def) \
 306 DRI_CONF_OPT_BEGIN(device_id, string, def) \
 307         DRI_CONF_DESC(en,gettext("Define the graphic device to use if possible")) \
 308 DRI_CONF_OPT_END
 309
 310 #define DRI_CONF_DRI_DRIVER(def) \
 311 DRI_CONF_OPT_BEGIN(dri_driver, string, def) \
 312         DRI_CONF_DESC(en,gettext("Override the DRI driver to load")) \
 313 DRI_CONF_OPT_END
 314
 315 /**
 316  * \brief Gallium-Nine specific configuration options
 317  */
 318
 319 #define DRI_CONF_SECTION_NINE \
 320 DRI_CONF_SECTION_BEGIN \
 321         DRI_CONF_DESC(en,gettext("Gallium Nine"))
 322
 323 #define DRI_CONF_NINE_THROTTLE(def) \
 324 DRI_CONF_OPT_BEGIN(throttle_value, int, def) \
 325         DRI_CONF_DESC(en,gettext("Define the throttling value. -1 for no throttling, -2 for default (usually 2), 0 for glfinish behaviour")) \
 326 DRI_CONF_OPT_END
 327
 328 #define DRI_CONF_NINE_THREADSUBMIT(def) \
 329 DRI_CONF_OPT_BEGIN_B(thread_submit, def) \
 330         DRI_CONF_DESC(en,gettext("Use an additional thread to submit buffers.")) \
 331 DRI_CONF_OPT_END
 332
 333 #define DRI_CONF_NINE_OVERRIDEVENDOR(def) \
 334 DRI_CONF_OPT_BEGIN(override_vendorid, int, def) \
 335         DRI_CONF_DESC(en,gettext("Define the vendor_id to report. This allows faking another hardware vendor.")) \
 336 DRI_CONF_OPT_END
 337
 338 #define DRI_CONF_NINE_ALLOWDISCARDDELAYEDRELEASE(def) \
 339 DRI_CONF_OPT_BEGIN_B(discard_delayed_release, def) \
 340         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).")) \
 341 DRI_CONF_OPT_END
 342
 343 #define DRI_CONF_NINE_TEARFREEDISCARD(def) \
 344 DRI_CONF_OPT_BEGIN_B(tearfree_discard, def) \
 345         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.")) \
 346 DRI_CONF_OPT_END
 347
 348 #define DRI_CONF_NINE_CSMT(def) \
 349 DRI_CONF_OPT_BEGIN(csmt_force, int, def) \
 350         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.")) \
 351 DRI_CONF_OPT_END
 352
 353 /**
 354  * \brief radeonsi specific configuration options
 355  */
 356
 357 #define DRI_CONF_RADEONSI_ENABLE_SISCHED(def) \
 358 DRI_CONF_OPT_BEGIN_B(radeonsi_enable_sisched, def) \
 359         DRI_CONF_DESC(en,gettext("Use the LLVM sisched option for shader compiles")) \
 360 DRI_CONF_OPT_END
 361
 362 #define DRI_CONF_RADEONSI_ASSUME_NO_Z_FIGHTS(def) \
 363 DRI_CONF_OPT_BEGIN_B(radeonsi_assume_no_z_fights, def) \
 364         DRI_CONF_DESC(en,gettext("Assume no Z fights (enables aggressive out-of-order rasterization to improve performance; may cause rendering errors)")) \
 365 DRI_CONF_OPT_END
 366
 367 #define DRI_CONF_RADEONSI_COMMUTATIVE_BLEND_ADD(def) \
 368 DRI_CONF_OPT_BEGIN_B(radeonsi_commutative_blend_add, def) \
 369         DRI_CONF_DESC(en,gettext("Commutative additive blending optimizations (may cause rendering errors)")) \
 370 DRI_CONF_OPT_END
 371
 372 #define DRI_CONF_RADEONSI_CLEAR_DB_CACHE_BEFORE_CLEAR(def) \
 373 DRI_CONF_OPT_BEGIN_B(radeonsi_clear_db_cache_before_clear, def) \
 374         DRI_CONF_DESC(en,"Clear DB cache before fast depth clear") \
 375 DRI_CONF_OPT_END
 376
 377 #define DRI_CONF_RADEONSI_ZERO_ALL_VRAM_ALLOCS(def) \
 378 DRI_CONF_OPT_BEGIN_B(radeonsi_zerovram, def) \
 379         DRI_CONF_DESC(en,"Zero all vram allocations") \
 380 DRI_CONF_OPT_END