Naming conventions
This topic defines the terms Iray API and neuray and the naming conventions used by neuray.
-
Product name: Iray API refers to the API shipped with Iray
-
Library name: neuray refers to the library of functions used by the Iray API.
The neuray library is written in C++. It uses the following naming conventions:
-
Namespaces: Use mi and mi::neuraylib for neuray identifiers
-
Macro names: Use MI_NEURAYLIB_ as a prefix
-
Identifier names: Use _ to concatenate multiple words
-
Function names: Are written in lowercase only
-
Type and class names: Start with one initial uppercase letter
-
Interface class names: Start with an additional capital I.