doc/tutorials/conventions/dwx_api_naming_structures.md

Go to the documentation of this file.

# Copyright (c) 2019-2020 NVIDIA CORPORATION.  All rights reserved.

@page dwx_naming_conventions API Naming Conventions and General Structures
@tableofcontents

NVIDIA<sup>&reg;</sup> DriveWorks is a collection of modules with C APIs. 

@section dwx_naming_functions Functions

Module functions are defined in camel case, as following:

```{.cpp}
DW_API_PUBLIC
dwStatus dwModule_functionName(.., dwModuleHandle_t obj)
```

@section dwx_naming_handles Handles

Each module provides a handle to access module functions.

```{.cpp}
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.
```

@section dwx_naming_structures Structures

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

```{.cpp}
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.

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