Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 1 | # This is an example vk_layer_settings.txt file. |
| 2 | # This file allows for per-layer settings which can dynamically affect layer |
| 3 | # behavior. Comments in this file are denoted with the "#" char. |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 4 | # Settings lines are of the form "<LayerIdentifier>.<SettingName> = <SettingValue>" |
| 5 | # |
| 6 | # <LayerIdentifier> is typically the official layer name, minus the VK_LAYER prefix |
Tobin Ehlis | c96f806 | 2016-03-09 16:12:48 -0700 | [diff] [blame] | 7 | # and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_core_validation, the layer |
| 8 | # identifier is 'lunarg_core_validation', and for VK_LAYER_GOOGLE_threading the layer |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 9 | # identifier is 'google_threading'. |
| 10 | # |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 11 | # There are some common settings that are used by each layer. |
| 12 | # Below is a general description of three common settings, followed by |
| 13 | # actual template settings for each layer in the SDK. |
| 14 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 15 | # Common settings descriptions: |
| 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 | # ============= |
| 20 | # <LayerIdentifier>.debug_action : This is an enum value indicating what action is to |
| 21 | # be taken when a layer wants to report information. Possible settings values |
| 22 | # are defined in the vk_layer.h header file. These settings are: |
| 23 | # VK_DBG_LAYER_ACTION_IGNORE - Take no action |
| 24 | # VK_DBG_LAYER_ACTION_LOG_MSG - Log a txt message to stdout or to a log file |
| 25 | # specified via the <LayerIdentifier>.log_filename setting (see below) |
| 26 | # VK_DBG_LAYER_ACTION_CALLBACK - Call user defined callback function(s) that |
| 27 | # have been registered via the VK_EXT_LUNARG_debug_report extension. Since |
| 28 | # app must register callback, this is a NOOP for the settings file. |
| 29 | # VK_DBG_LAYER_ACTION_BREAK - Trigger a breakpoint. |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 30 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 31 | # REPORT_FLAGS: |
| 32 | # ============= |
| 33 | # <LayerIdentifier>.report_flags : This is a comma-delineated list of options telling |
| 34 | # the layer what types of messages it should report back. Options are: |
| 35 | # info - Report informational messages |
| 36 | # warn - Report warnings of using the API in an unrecommended manner which may |
| 37 | # also lead to undefined behavior |
| 38 | # perf - Report using the API in a way that may cause suboptimal performance |
| 39 | # error - Report errors in API usage |
| 40 | # debug - For layer development. Report messages for debugging layer behavior |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 41 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 42 | # LOG_FILENAME: |
| 43 | # ============= |
| 44 | # <LayerIdentifier>.log_filename : output filename. Can be relative to location of |
| 45 | # vk_layer_settings.txt file, or an absolute path. If no filename is |
| 46 | # specified or if filename has invalid path, then stdout is used by default. |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 47 | # |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 48 | # |
| 49 | # |
| 50 | # Example of actual settings for each layer: |
| 51 | # ========================================== |
| 52 | # |
| 53 | # VK_LAYER_LUNARG_device_limits Settings |
| 54 | lunarg_device_limits.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 55 | lunarg_device_limits.report_flags = error,warn,perf |
| 56 | lunarg_device_limits.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 57 | |
Tobin Ehlis | c96f806 | 2016-03-09 16:12:48 -0700 | [diff] [blame] | 58 | # VK_LAYER_LUNARG_core_validation Settings |
| 59 | lunarg_core_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 60 | lunarg_core_validation.report_flags = error,warn,perf |
| 61 | lunarg_core_validation.log_filename = stdout |
| 62 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 63 | # VK_LAYER_LUNARG_image Settings |
| 64 | lunarg_image.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 65 | lunarg_image.report_flags = error,warn,perf |
| 66 | lunarg_image.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 67 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 68 | # VK_LAYER_LUNARG_object_tracker Settings |
| 69 | lunarg_object_tracker.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 70 | lunarg_object_tracker.report_flags = error,warn,perf |
| 71 | lunarg_object_tracker.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 72 | |
Mark Lobodzinski | 739391a | 2016-03-17 15:08:18 -0600 | [diff] [blame] | 73 | # VK_LAYER_LUNARG_parameter_validation Settings |
| 74 | lunarg_parameter_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 75 | lunarg_parameter_validation.report_flags = error,warn,perf |
| 76 | lunarg_parameter_validation.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 77 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 78 | # VK_LAYER_LUNARG_swapchain Settings |
| 79 | lunarg_swapchain.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 80 | lunarg_swapchain.report_flags = error,warn,perf |
| 81 | lunarg_swapchain.log_filename = stdout |
Ian Elliott | 0b4d624 | 2015-09-22 10:51:24 -0600 | [diff] [blame] | 82 | |
Mark Lobodzinski | 8cbde24 | 2016-02-23 09:58:39 -0700 | [diff] [blame] | 83 | # VK_LAYER_GOOGLE_threading Settings |
| 84 | google_threading.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG |
| 85 | google_threading.report_flags = error,warn,perf |
| 86 | google_threading.log_filename = stdout |
Tobin Ehlis | 2b57c7b | 2015-09-15 09:54:07 -0600 | [diff] [blame] | 87 | |