Module: vkd3d
Branch: master
Commit: 1930e60ab38d9b11cce46a90d7a2245c478fbe3d
URL: https://source.winehq.org/git/vkd3d.git/?a=commit;h=1930e60ab38d9b11cce46a9…
Author: Józef Kucia <jkucia(a)codeweavers.com>
Date: Fri May 17 10:39:16 2019 +0200
readme: Document build macros.
Signed-off-by: Józef Kucia <jkucia(a)codeweavers.com>
Signed-off-by: Henri Verbeet <hverbeet(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>
---
README | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/README b/README
index b9853ba..2e42249 100644
--- a/README
+++ b/README
@@ -19,6 +19,11 @@ available or is not recent (>= 3.20), then you can build Wine with `make
tools/widl' to avoid building all of Wine. You can then point vkd3d's
configure at that widl binary with `WIDL="/path/to/widl"'.
+For release builds, you may want to define NDEBUG. If you do not need debug log
+messages, you may also consider VKD3D_NO_TRACE_MESSAGES and
+VKD3D_NO_DEBUG_MESSAGES. For example, you can pass `CPPFLAGS="-DNDEBUG
+-DVKD3D_NO_TRACE_MESSAGES"' to configure.
+
===========
Using vkd3d
===========
Module: vkd3d
Branch: master
Commit: 33ba9b27ed7cb8d43a655130fcbad368fa195116
URL: https://source.winehq.org/git/vkd3d.git/?a=commit;h=33ba9b27ed7cb8d43a65513…
Author: Józef Kucia <jkucia(a)codeweavers.com>
Date: Fri May 17 10:39:15 2019 +0200
readme: Document environment variables.
Signed-off-by: Józef Kucia <jkucia(a)codeweavers.com>
Signed-off-by: Henri Verbeet <hverbeet(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>
---
README | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/README b/README
index be329e1..b9853ba 100644
--- a/README
+++ b/README
@@ -28,3 +28,40 @@ at build-time with some modest source modifications.
If vkd3d is available when building Wine, then Wine will use it to support
Direct3D 12 applications.
+
+=====================
+Environment variables
+=====================
+
+Most of the environment variables used by vkd3d are for debugging purposes. The
+environment variables are not considered a part of API and might be changed or
+removed in the future versions of vkd3d.
+
+Some of debug variables are lists of elements. Elements must be separated by
+commas or semicolons.
+
+ * VKD3D_CONFIG - a list of options that change the behavior of libvkd3d.
+ * vk_debug - enables Vulkan debug extensions.
+
+ * VKD3D_DEBUG - controls the debug level for log messages produced by
+ libvkd3d. Accepts the following values: none, err, fixme, warn, trace.
+
+ * VKD3D_VULKAN_DEVICE - a zero-based device index. Use to force the selected
+ Vulkan device.
+
+ * VKD3D_DISABLE_EXTENSIONS - a list of Vulkan extensions that libvkd3d should
+ not use even if available.
+
+ * VKD3D_SHADER_DEBUG - controls the debug level for log messages produced by
+ libvkd3d-shader. See VKD3D_DEBUG for accepted values.
+
+ * VKD3D_SHADER_DUMP_PATH - path where shader bytecode is dumped.
+
+ * VKD3D_TEST_DEBUG - enables additional debug messages in tests. Set to 0, 1
+ or 2.
+
+ * VKD3D_TEST_PLATFORM - can be set to "wine", "windows" or "other". The test
+ platform controls the behavior of todo(), todo_if(), bug_if() and broken()
+ conditions in tests.
+
+ * VKD3D_TEST_BUG - set to 0 to disable bug_if() conditions in tests.