DriveWorks SDK Reference
3.0.4260 Release
For Test and Development only

/dvs/git/dirty/gitlab-master_av/dw/sdk/samples/template/README.md
Go to the documentation of this file.
1 # Copyright (c) 2017-2019 NVIDIA CORPORATION. All rights reserved.
2 
3 @page dwx_sample_template Template for a sample
4 @tableofcontents
5 
6 @section dwx_sample_template_description Description
7 
8 This is a template sample showing how to write new samples.
9 
10 @section dwx_sample_template_running Running the Sample
11 
12 The occupancy grid sample, sample_template, accepts the following optional parameters.
13 
14  ./sample_template --optionA=[stuff]
15  --optionB=[stuff]
16 
17 where
18 
19  --optionA=[stuff]
20  Description of the parameter
21  Default value:
22 
23  --optionB=[stuff]
24  Description of the parameter
25  Default value:
26 
27 Short description of any runtime commands accepted by the sample.
28 
29 @subsection dwx_sample_template_examples Examples
30 
31 #### Runnign sample_template in offscreen mode
32 
33  ./sample_template --offscreen=1
34 
35 #### Runnign sample_template with custom parameters
36 
37  ./sample_template --optionA=A --optionB=B
38 
39 @section dwx_sample_template_output Output
40 
41 Short description of the sample's output.
42 
43 ![Screenshot of application](sample_mytemplate.png)
44 
45 @section dwx_sample_template_more Additional Information
46 
47 For more details see <add reference to the the modules used in this sample>