maps/docs/usecase1.md

Go to the documentation of this file.

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

@page maps_usecase1 Map Provider Initialization

@note SW Release Applicability: This tutorial is applicable to modules in **NVIDIA DRIVE Software** releases.

The initialization functions of the map provider are:

```{.cpp}
    typedef struct dwMapProviderParameters {
        size_t numAllocatedMaps;        //!< Number of maps to allocate for requests
        size_t totalMapAllocationBytes; //!< Total memory available for map requests
    } dwMapProviderParameters;

    dwStatus dwMapProvider_initializeWithCacheFile(
        dwMapProviderHandle_t* providerHandle,
        const char* mapCacheFile,
        dwMapProviderParameters* params,
        dwContextHandle_t contextHandle);

    dwStatus dwMapProvider_initializeWithDirectory(
        dwMapProviderHandle_t* providerHandle,
        const char* mapDirectory,
        dwMapProviderParameters* params,
        dwContextHandle_t contextHandle);
```

Note the map provider parameters are significant as they determine per-map and total memory allocations.

The initializer examines the provided map cache file (XML) or map directory and prepares to serve map requests.
It returns a handle to a map provider that should be used to request Map data as needed. Initially the Map Provider
is backed by content in the local filesystem, including map cache files (XML).

Map cache files can be created with a conversion tool (see @ref dwx_maptool_here_to_dw_maps).

For more information see @ref dwx_hd_map_access_sample .