aboutsummaryrefslogtreecommitdiff
path: root/src/dx/context/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/dx/context/README.md')
-rw-r--r--src/dx/context/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/dx/context/README.md b/src/dx/context/README.md
new file mode 100644
index 0000000..7b45ecd
--- /dev/null
+++ b/src/dx/context/README.md
@@ -0,0 +1,7 @@
+The interfaces in this folder define a thin wrapper around D3D11 and D3D12 APIs that
+are used internally by the Flex solver. Some parts of the Flex API (e.g.: solver callbacks)
+will return pointers to these structures.
+
+See the extensions forcefield API for an example of how these wrappers may be used to implement
+Flex solver callbacks. Note that this code should not be modified or recompiled to ensure binary
+compatibility with the main Flex libraries.