blob: f5dcb5f657b065fcf4f3aab27a242cc4026c15cc [file] [log] [blame]
Karl Schultz8e31c2a2016-10-03 11:15:26 -06001################################################################################
Mark Lobodzinskic71f3e92016-06-01 16:12:49 -06002#
Karl Schultz8e31c2a2016-10-03 11:15:26 -06003# 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 Lobodzinski8cbde242016-02-23 09:58:39 -07007#
Karl Schultz8e31c2a2016-10-03 11:15:26 -06008# <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 Lobodzinski8cbde242016-02-23 09:58:39 -070012#
Karl Schultz8e31c2a2016-10-03 11:15:26 -060013################################################################################
14################################################################################
15# Validation Layer Common Settings:
16# =================================
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060017#
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070018# DEBUG_ACTION:
19# =============
Karl Schultz8e31c2a2016-10-03 11:15:26 -060020# <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 Lobodzinski8cbde242016-02-23 09:58:39 -070027# VK_DBG_LAYER_ACTION_CALLBACK - Call user defined callback function(s) that
Mark Young3d721ad2016-09-01 09:18:45 -060028# have been registered via the VK_EXT_debug_report extension. Since
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070029# app must register callback, this is a NOOP for the settings file.
Karl Schultz8e31c2a2016-10-03 11:15:26 -060030# 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 Lobodzinski8cbde242016-02-23 09:58:39 -070033# VK_DBG_LAYER_ACTION_BREAK - Trigger a breakpoint.
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060034#
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070035# REPORT_FLAGS:
36# =============
Karl Schultz8e31c2a2016-10-03 11:15:26 -060037# <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 Ehlis2b57c7b2015-09-15 09:54:07 -060048#
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070049# LOG_FILENAME:
50# =============
Karl Schultz8e31c2a2016-10-03 11:15:26 -060051# <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 Lobodzinski8cbde242016-02-23 09:58:39 -070055#
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060056
Tobin Ehlisc96f8062016-03-09 16:12:48 -070057# VK_LAYER_LUNARG_core_validation Settings
58lunarg_core_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
59lunarg_core_validation.report_flags = error,warn,perf
60lunarg_core_validation.log_filename = stdout
61
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070062# VK_LAYER_LUNARG_image Settings
63lunarg_image.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
64lunarg_image.report_flags = error,warn,perf
65lunarg_image.log_filename = stdout
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060066
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070067# VK_LAYER_LUNARG_object_tracker Settings
68lunarg_object_tracker.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
69lunarg_object_tracker.report_flags = error,warn,perf
70lunarg_object_tracker.log_filename = stdout
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060071
Mark Lobodzinski739391a2016-03-17 15:08:18 -060072# VK_LAYER_LUNARG_parameter_validation Settings
73lunarg_parameter_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
74lunarg_parameter_validation.report_flags = error,warn,perf
75lunarg_parameter_validation.log_filename = stdout
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060076
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070077# VK_LAYER_LUNARG_swapchain Settings
78lunarg_swapchain.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
79lunarg_swapchain.report_flags = error,warn,perf
80lunarg_swapchain.log_filename = stdout
Ian Elliott0b4d6242015-09-22 10:51:24 -060081
Mark Lobodzinski8cbde242016-02-23 09:58:39 -070082# VK_LAYER_GOOGLE_threading Settings
83google_threading.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
84google_threading.report_flags = error,warn,perf
85google_threading.log_filename = stdout
Tobin Ehlis2b57c7b2015-09-15 09:54:07 -060086
Mark Lobodzinskib5eee7c2016-08-26 08:37:44 -060087# VK_LAYER_GOOGLE_unique_objects Settings
88google_unique_objects.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
89google_unique_objects.report_flags = error,warn,perf
90google_unique_objects.log_filename = stdout
Karl Schultz8e31c2a2016-10-03 11:15:26 -060091################################################################################