summaryrefslogtreecommitdiffstats
path: root/dwl-patches/patches/toggle_constraints/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dwl-patches/patches/toggle_constraints/README.md')
-rw-r--r--dwl-patches/patches/toggle_constraints/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/dwl-patches/patches/toggle_constraints/README.md b/dwl-patches/patches/toggle_constraints/README.md
new file mode 100644
index 0000000..7f2be77
--- /dev/null
+++ b/dwl-patches/patches/toggle_constraints/README.md
@@ -0,0 +1,17 @@
+### Description
+Adds a function called togglepointerconstraints to turn pointer constraint enforcement on and off with a keybind.
+
+### Usage
+Add a binding for the togglepointerconstraints function in the keys[] array of config.h. The function does not take any argument. Pointer constraints default to enabled, and can be toggled on and off with the function from there.
+
+Example:
+```
+{ MODKEY, XKB_KEY_c, togglepointerconstraints, {0}},
+```
+
+### Download
+- [Git branch](https://codeberg.org/thanatos/dwl/src/branch/toggle_constraints)
+- [2024-03-26](https://codeberg.org/dwl/dwl-patches/raw/branch/main/patches/toggle_constraints/toggle_constraints)
+
+### Authors
+- [thanatos](https://codeberg.org/thanatos) \ No newline at end of file