HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UT_HDKVersion.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: UT_HDKVersion.h (UT Library, C++)
7  *
8  * COMMENTS:
9  */
10 
11 #ifndef __UT_HDKVERSION_H_INCLUDED__
12 #define __UT_HDKVERSION_H_INCLUDED__
13 
14 #include "UT_API.h"
15 
16 /// @file UT_HDKVersion.h
17 
18 /// Macro that specifies the HDK API version.
19 ///
20 /// This monotonically increasing value is updated to the last Houdini version
21 /// with known ABI incompatibilities. Typically, this will be set on every
22 /// major release and only occasionally on releases within a X.Y version.
23 ///
24 /// Note this does not include stub versions, so one should assume ABI
25 /// is incompatible between stub versions (16.0.459.3 -> 16.0.459.4).
26 ///
27 /// This number is only updated after release. If you are using alpha
28 /// or beta versions, you should assume ABI is always incompatible.
29 ///
30 /// The format is a packed 8 digit integer consisting of version of Houdini
31 /// when the API was last changed:
32 /// ("%02d%02d%04d", major, minor, build)
33 /// See the corresponding SYS_VERSION_* defines in SYS_Version.h.
34 ///
35 /// Usage:
36 /// @code
37 /// // If using the HDK since the API change from Houdini 15.5.499
38 /// #if HDK_API_VERSION >= 15050499
39 /// #endif
40 /// @endcode
41 #define HDK_API_VERSION 17000428
42 
43 /// Returns the runtime HDK API version. This can be used by plugins to warn or
44 /// error if running in an unsupported Houdini version.
45 UT_API unsigned UTgetHDKAPIVersion();
46 
47 #endif // __UT_HDKVERSION_H_INCLUDED__
#define UT_API
Definition: UT_API.h:13
UT_API unsigned UTgetHDKAPIVersion()