-
Notifications
You must be signed in to change notification settings - Fork 64
/
vk_layer_settings.txt
127 lines (119 loc) · 5.39 KB
/
vk_layer_settings.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# This is an example vk_layer_settings.txt file.
#
# This file allows for per-layer settings which can dynamically affect layer
# behavior. Comments in this file are denoted with the "#" char.
# Settings lines are of the form "<LayerIdentifier>.<SettingName> = <SettingValue>"
#
# <LayerIdentifier> is typically the official layer name, minus the VK_LAYER prefix
# and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_core_validation, the layer
# identifier is 'lunarg_core_validation', and for VK_LAYER_GOOGLE_threading the layer
# identifier is 'google_threading'.
#
# There are some common settings that are used by each layer.
# Below is a general description of three common settings, followed by
# actual template settings for each layer in the SDK.
#
# Common settings descriptions:
# =============================
#
# DEBUG_ACTION:
# =============
# <LayerIdentifier>.debug_action : This is an enum value indicating what action is to
# be taken when a layer wants to report information. Possible settings values
# are defined in the vk_layer.h header file. These settings are:
# VK_DBG_LAYER_ACTION_IGNORE - Take no action
# VK_DBG_LAYER_ACTION_LOG_MSG - Log a txt message to stdout or to a log file
# specified via the <LayerIdentifier>.log_filename setting (see below)
# VK_DBG_LAYER_ACTION_CALLBACK - Call user defined callback function(s) that
# have been registered via the VK_EXT_LUNARG_debug_report extension. Since
# app must register callback, this is a NOOP for the settings file.
# VK_DBG_LAYER_DEBUG_OUTPUT [Windows only] - Log a txt message using the Windows
# OutputDebugString function -- messages will show up in Visual Studio output
# window, for instance.
# VK_DBG_LAYER_ACTION_BREAK - Trigger a breakpoint.
#
# REPORT_FLAGS:
# =============
# <LayerIdentifier>.report_flags : This is a comma-delineated list of options telling
# the layer what types of messages it should report back. Options are:
# info - Report informational messages
# warn - Report warnings from using the API in a manner which may lead to undefined
# behavior or to warn the user of common trouble spots. A warning does NOT
# necessarily signify illegal application behavior.
# perf - Report using the API in a way that may cause suboptimal performance
# error - Report errors in API usage
# debug - For layer development. Report messages for debugging layer behavior
#
# LOG_FILENAME:
# =============
# <LayerIdentifier>.log_filename : output filename. Can be relative to location of
# vk_layer_settings.txt file, or an absolute path. If no filename is
# specified or if filename has invalid path, then stdout is used by default.
#
#
#
# Example of actual settings for each layer:
# ==========================================
#
# VK_LAYER_LUNARG_core_validation Settings
lunarg_core_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
lunarg_core_validation.report_flags = error,warn,perf
lunarg_core_validation.log_filename = stdout
# VK_LAYER_LUNARG_image Settings
lunarg_image.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
lunarg_image.report_flags = error,warn,perf
lunarg_image.log_filename = stdout
# VK_LAYER_LUNARG_object_tracker Settings
lunarg_object_tracker.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
lunarg_object_tracker.report_flags = error,warn,perf
lunarg_object_tracker.log_filename = stdout
# VK_LAYER_LUNARG_parameter_validation Settings
lunarg_parameter_validation.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
lunarg_parameter_validation.report_flags = error,warn,perf
lunarg_parameter_validation.log_filename = stdout
# VK_LAYER_LUNARG_swapchain Settings
lunarg_swapchain.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
lunarg_swapchain.report_flags = error,warn,perf
lunarg_swapchain.log_filename = stdout
# VK_LAYER_GOOGLE_threading Settings
google_threading.debug_action = VK_DBG_LAYER_ACTION_LOG_MSG
google_threading.report_flags = error,warn,perf
google_threading.log_filename = stdout
# This is an example vk_layer_settings.txt file.
# This file allows for per-layer settings which can dynamically affect layer
# behavior. Comments in this file are denoted with the "#" char.
# Settings lines are of the form "<LayerIdentifier>.<SettingName> = <SettingValue>"
#
# <LayerIdentifier> is typically the official layer name, minus the VK_LAYER prefix
# and all lower-camel-case -- i.e., for VK_LAYER_LUNARG_api_dump, the layer
# identifier is 'lunarg_api_dump'.
#
#
# VK_LUNARG_LAYER_api_dump Settings:
# ==================================
#
# DETAILED:
# =============
# <LayerIdentifer>.detailed : Setting this to TRUE causes parameter details
# to be dumped in addition to API calls
lunarg_api_dump.detailed = TRUE
# NO_ADDR:
# =============
# <LayerIdentifier>.no_addr : Setting this to TRUE causes "address" to be
# dumped in place of hex addresses
lunarg_api_dump.no_addr = FALSE
# FILE:
# =============
# <LayerIdentifer>.file : Setting this to TRUE indicates that output
# should be written to file instead of STDOUT
lunarg_api_dump.file = FALSE
# LOG_FILENAME:
# =============
# <LayerIdentifer>.log_filename : Specifies the file to dump to when
# "file = TRUE". The default is "vk_apidump.txt"
lunarg_api_dump.log_filename = stdout
# FLUSH:
# =============
# <LayerIdentifier>.flush : Setting this to TRUE causes IO to be flushed after
# each line that's written
lunarg_api_dump.flush = TRUE