API Naming Conventions and General Structures

Table of Contents

• Functions
• Handles
• Structures

NVIDIA? DriveWorks is a collection of modules with C APIs.

Functions

Module functions are defined in camel case, as following:

DW_API_PUBLIC
dwStatus dwModule_functionName(.., dwModuleHandle_t obj)

Handles

Each module provides a handle to access module functions.

typedef struct dwContextObject * dwContextHandle_t            // Defines a type-safe handle to the instance of a module.
typedef struct dwContextObject const* dwConstContextHandle_t  // Defines a type-safe handle to a const instance of a module.

Structures

Structures supporting the module are defined with a typedef and prefixed module name in camel case.

typedef struct dwMyModuleParameterStruct {
    float32_t parameterOne;
    int32_t parameterTwo;
} dwMyModuleParameterStruct;

Enums

Enums are defined with a prefix of the module name, where each element is:

• Prefixed with the module name using _ as a separator and
• In capital letters.

typedef enum dwMyModulParamFlags
{
    DW_MY_MODULE_PARAM_FLAGS_ONE = 0,
    DW_MY_MODULE_PARAM_FLAGS_TWO = 1,
} dwMyModuleParamFlags;