The Iray SDK API is based on and uses the base API and the math API.
The base API provides basic types, functions on them, assertions, and configurations. The math API provides vector, matrix, bbox, and color classes and math functions.
The Iray SDK API offers two groups of include files. One group consists of the main include files while the other group consists of the sub-include files.
Include files are self-contained. Internal dependencies are resolved automatically. As a consequence, their inclusion is order independent.
The main include files provide the full functionality of their respective API. They do so by including all necessary sub-include files.
| Main Include File | Description |
|---|---|
mi/base.h | Includes all sub-include files of the base API. |
mi/math.h | Includes mi/base.h and all sub-include files of the math API. |
mi/neuraylib.h | Includes mi/base.h, mi/math.h and all sub-include files of the Iray SDK API. Simply including this header gives you access to all the functionality of Iray SDK API. |
The sub-include files provide individual parts of their respective API grouped by functionality. If you include the respective main include file of an API, then there is no need to include sub-include files of that API anymore and of those APIs it relies on.
There may be include files that are not documented here. They are automatically included if needed and their independent use is not supported. Their naming and organization might change in the future.
See Base API Include Files for the individual sub-include files of the base API.
See Math API Include Files for the individual sub-include files of the math API.
| Iray Sub-include File | Description | Documentation |
|---|---|---|
mi/neuraylib/version.h | Version number for the Iray SDK API. | Versioning of the Iray SDK API |
mi/neuraylib/assert.h | Assertions and static assertions. | Iray SDK API Assertions |
