summaryrefslogtreecommitdiff
path: root/slang.h
diff options
context:
space:
mode:
Diffstat (limited to 'slang.h')
-rw-r--r--slang.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/slang.h b/slang.h
index c707e8918..9720b04cb 100644
--- a/slang.h
+++ b/slang.h
@@ -1278,6 +1278,22 @@ extern "C"
SlangCompileRequest* request,
SlangOptimizationLevel level);
+
+ /*!
+ @brief Get the build version 'tag' string. The string is the same as produced via `git describe --tags`
+ for the project. If Slang is built separately from the automated build scripts
+ the contents will by default be 'unknown'. Any string can be set by changing the
+ contents of 'slang-tag-version.h' file and recompiling the project.
+
+ This function will return exactly the same result as the method getBuildTag string on IGlobalSession.
+
+ An advantage of using this function over the method is that doing so does not require the creation of
+ a session, which can be a fairly costly operation.
+
+ @return The build tag string
+ */
+ SLANG_API const char* spGetBuildTagString();
+
/*!
@brief Set the container format to be used for binary output.
*/
@@ -2869,6 +2885,8 @@ namespace slang
the contents will by default be 'unknown'. Any string can be set by changing the
contents of 'slang-tag-version.h' file and recompiling the project.
+ This method will return exactly the same result as the free function spGetBuildTagString.
+
@return The build tag string
*/
virtual SLANG_NO_THROW const char* SLANG_MCALL getBuildTagString() = 0;