From dbfa6d8f8bab8810fcc4ee7df42c77004458b2d9 Mon Sep 17 00:00:00 2001
From: FlightlessMango <flightlessmangoyt@gmail.com>
Date: Fri, 13 Mar 2020 16:50:26 +0100
Subject: [PATCH] [readme] vsync opengl and vulkan explanation

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d261f112..a50004ff 100644
--- a/README.md
+++ b/README.md
@@ -80,10 +80,23 @@ A partial list of parameters are below. See the config file for a complete list.
 | `output_file`                      | Define name and location of the output file (Required for logging)                    |
 | `font_file`                        | Change default font (set location to .TTF/.OTF file )                                 |
 | `log_duration`                     | Set amount of time the logging will run for (in seconds)                              |
+| `vsync`<br> `gl_vsync              | Set vsync for OpenGL or Vulkan                                                        |
+
+Example: `MANGOHUD_CONFIG=cpu_temp,gpu_temp,position=top-right,height=500,font_size=32`
 
 Note: Width and Height are set automatically based on the font_size, but can be overridden.
+## Vsync
+### OpenGL Vsync
+- `-1` = Adaptive sync
+- `0`  = Off
+- `1`  = On
+
+### Vulkan Vsync
+- `0` = Adaptive VSync
+- `1` = Off
+- `2` = Mailbox (VSync with uncapped FPS)
+- `3` = On
 
-Example: `MANGOHUD_CONFIG=cpu_temp,gpu_temp,position=top-right,height=500,font_size=32`
 
 ## Keybindings