The DiCE 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 DiCE API contains the base API and math API include files as well. The mi/base.h include file and all include files in the mi/base/ subdirectory are from the base API. The mi/math.h include file and all include files in the mi/math/ subdirectory are from the math API. The mi/dice.h include file and all include files in the mi/neuraylib/ subdirectory are from the DiCE API.
The DiCE API offers two groups of include files. One group contains the mi/dice.h, mi/math.h, and mi/base.h include files, which provide the full functionality of the DiCE API, the math API, and the base API, respectively. The other group consists of several include files named mi/neuraylib/<functional-name>.h, which provide individual parts of the DiCE API grouped by functionality, mi/math/<functional-name>.h, which provide individual parts of the math API grouped by functionality, and mi/base/<functional-name>.h, which provide individual parts of the base API grouped by functionality. The files of the first group, mi/dice.h, mi/math.h, and mi/base.h, include all relevant files of the second group.
See Base API Include Files for the individual base API include files grouped by component.
See Math API Include Files for the individual math API include files grouped by component.
Include files are self-contained. Internal dependencies are resolved automatically. As a consequence, their inclusion is order independent.
| Main Include File | Description |
|---|---|
mi/base.h | Includes all sub-include files of the base API. |
mi/math.h | Includes all sub-include files of the math API and mi/base.h. |
mi/dice.h | Includes all sub-include files of the DiCE API, mi/base.h, and mi/math.h. Simply including this header gives you access to all the functionality of DiCE API. |
There may be include files that are not documented below. They are automatically included if needed and their independent use is not supported. Their naming and organization might change in the future.
| DiCE Include Files Grouped by Component | Description | Documentation |
|---|---|---|
mi/neuraylib/version.h | Version number for the DiCE API. | Versioning of the DiCE API |
mi/neuraylib/assert.h | Assertions and static assertions. | DiCE API Assertions |
