Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 1 | ################################################################################ |
Mark Lobodzinski | c71f3e9 | 2016-06-01 16:12:49 -0600 | [diff] [blame] | 2 | # |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 3 | # This file contains per-layer settings that configure layer behavior at |
| 4 | # execution time. Comments in this file are denoted with the "#" char. |
| 5 | # Settings lines are of the form: |
| 6 | # "<LayerIdentifier>.<SettingName> = <SettingValue>" |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 7 | # |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 8 | # <LayerIdentifier> is typically the official layer name, minus the VK_LAYER |
| 9 | # prefix and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_core_validation, |
| 10 | # the layer identifier is 'lunarg_core_validation', and for |
| 11 | # VK_LAYER_GOOGLE_threading the layeridentifier is 'google_threading'. |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 12 | # |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 13 | ################################################################################ |
| 14 | ################################################################################ |
| 15 | # Validation Layer Common Settings: |
| 16 | # ================================= |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 17 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 18 | # DEBUG_ACTION: |
| 19 | # ============= |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 20 | # <LayerIdentifier>.debug_action : This is an enum value indicating what |
| 21 | # action is to be taken when a layer wants to report information. |
| 22 | # Possible settings values are defined in the vk_layer.h header file. |
| 23 | # These settings are: |
| 24 | # VK_DBG_LAYER_ACTION_IGNORE - Take no action. |
| 25 | # VK_DBG_LAYER_ACTION_LOG_MSG - Log a txt message to stdout or to a log filename |
| 26 | # specified via the <LayerIdentifier>.log_filename setting (see below). |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 27 | # VK_DBG_LAYER_ACTION_CALLBACK - Call user defined callback function(s) that |
Mark Young | 3d721ad | 2016-09-01 09:18:45 -0600 | [diff] [blame] | 28 | # have been registered via the VK_EXT_debug_report extension. Since |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 29 | # app must register callback, this is a NOOP for the settings file. |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 30 | # VK_DBG_LAYER_DEBUG_OUTPUT [Windows only] - Log a txt message using the |
| 31 | # Windows OutputDebugString function -- messages will show up in the |
| 32 | # Visual Studio output window, for instance. |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 33 | # VK_DBG_LAYER_ACTION_BREAK - Trigger a breakpoint. |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 34 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 35 | # REPORT_FLAGS: |
| 36 | # ============= |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 37 | # <LayerIdentifier>.report_flags : This is a comma-delineated list of options |
| 38 | # telling the layer what types of messages it should report back. |
| 39 | # Options are: |
| 40 | # info - Report informational messages. |
| 41 | # warn - Report warnings from using the API in a manner which may lead to |
| 42 | # undefined behavior or to warn the user of common trouble spots. |
| 43 | # A warning does NOT necessarily signify illegal application behavior. |
| 44 | # perf - Report using the API in a way that may cause suboptimal performance. |
| 45 | # error - Report errors in API usage. |
| 46 | # debug - For layer development. Report messages for debugging layer |
| 47 | # behavior. |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 48 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 49 | # LOG_FILENAME: |
| 50 | # ============= |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 51 | # <LayerIdentifier>.log_filename : output filename. Can be relative to |
| 52 | # location of vk_layer_settings.txt file, or an absolute path. If no |
| 53 | # filename is specified or if filename has invalid path, then stdout |
| 54 | # is used by default. |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 55 | # |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 56 | |
Tobin Ehlis | c96f806 | 2016-03-09 16:12:48 -0700 | [diff] [blame] | 57 | # VK_LAYER_LUNARG_core_validation Settings |
| 58 | lunarg_core_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 59 | lunarg_core_validation.report_flags = error,warn,perf |
| 60 | lunarg_core_validation.log_filename = stdout |
| 61 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 62 | # VK_LAYER_LUNARG_image Settings |
| 63 | lunarg_image.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 64 | lunarg_image.report_flags = error,warn,perf |
| 65 | lunarg_image.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 66 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 67 | # VK_LAYER_LUNARG_object_tracker Settings |
| 68 | lunarg_object_tracker.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 69 | lunarg_object_tracker.report_flags = error,warn,perf |
| 70 | lunarg_object_tracker.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 71 | |
Mark Lobodzinski | 739391a | 2016-03-17 15:08:18 -0600 | [diff] [blame] | 72 | # VK_LAYER_LUNARG_parameter_validation Settings |
| 73 | lunarg_parameter_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 74 | lunarg_parameter_validation.report_flags = error,warn,perf |
| 75 | lunarg_parameter_validation.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 76 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 77 | # VK_LAYER_LUNARG_swapchain Settings |
| 78 | lunarg_swapchain.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 79 | lunarg_swapchain.report_flags = error,warn,perf |
| 80 | lunarg_swapchain.log_filename = stdout |
Ian Elliott | 0b4d624 | 2015-09-22 10:51:24 -0600 | [diff] [blame] | 81 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 82 | # VK_LAYER_GOOGLE_threading Settings |
| 83 | google_threading.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 84 | google_threading.report_flags = error,warn,perf |
| 85 | google_threading.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 86 | |
Mark Lobodzinski | b5eee7c | 2016-08-26 08:37:44 -0600 | [diff] [blame] | 87 | # VK_LAYER_GOOGLE_unique_objects Settings |
| 88 | google_unique_objects.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 89 | google_unique_objects.report_flags = error,warn,perf |
| 90 | google_unique_objects.log_filename = stdout |
Karl Schultz | 8e31c2a | 2016-10-03 11:15:26 -0600 | [diff] [blame] | 91 | ################################################################################ |