aboutsummaryrefslogtreecommitdiffstats
path: root/meson/docs/markdown/Windows-module.md
diff options
context:
space:
mode:
Diffstat (limited to 'meson/docs/markdown/Windows-module.md')
-rw-r--r--meson/docs/markdown/Windows-module.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/meson/docs/markdown/Windows-module.md b/meson/docs/markdown/Windows-module.md
new file mode 100644
index 000000000..a7131a734
--- /dev/null
+++ b/meson/docs/markdown/Windows-module.md
@@ -0,0 +1,30 @@
+# Windows module
+
+This module provides functionality used to build applications for
+Windows.
+
+## Methods
+
+### compile_resources
+
+Compiles Windows `rc` files specified in the positional arguments.
+Returns an opaque object that you put in the list of sources for the
+target you want to have the resources in. This method has the
+following keyword argument.
+
+- `args` lists extra arguments to pass to the resource compiler
+- `depend_files` lists resource files that the resource script depends on
+ (e.g. bitmap, cursor, font, html, icon, message table, binary data or manifest
+ files referenced by the resource script) (*since 0.47.0*)
+- `depends` lists target(s) that this target depends on, even though it does not
+ take them as an argument (e.g. as above, but generated) (*since 0.47.0*)
+- `include_directories` lists directories to be both searched by the resource
+ compiler for referenced resource files, and added to the preprocessor include
+ search path.
+
+The resource compiler executable used is the first which exists from the
+following list:
+
+1. The `windres` executable given in the `[binaries]` section of the cross-file
+2. The `WINDRES` environment variable
+3. The resource compiler which is part of the same toolset as the C or C++ compiler in use.