File: tutorial-install-win11-msvc17.dox

package info (click to toggle)
visp 3.7.0-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 166,384 kB
  • sloc: cpp: 392,705; ansic: 224,448; xml: 23,444; python: 13,701; java: 4,792; sh: 207; objc: 145; makefile: 118
file content (697 lines) | stat: -rw-r--r-- 30,743 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
/**

\page tutorial-install-win11-msvc17 Tutorial: Installation from source for Windows 11 with Visual C++ 2022 (vc17)
\tableofcontents

In this tutorial you will learn how to install ViSP from source on Windows 11 with Visual C++.
These steps have been tested on Windows 11 (64 bit), with CMake 3.24.2 and Visual Studio Community 2022.

\note Concerning ViSP installation, we provide also other \ref tutorial.

\section install_win11_msvc17_required 1. Install prerequisites

\subsection install_win11_msvc17_3rd_msvc 1.1. Visual Studio

Visual Studio Community 2022 could be downloaded from https://www.visualstudio.com/downloads/. During
a fresh installation enable "Desktop development with C++" workload (see image below).

If you already have Visual Studio Community 2022, you can check if "Desktop Development with C++"
workload is activated following instructions given
<a href="https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2022">here</a>
that we resume:

1. Find the Visual Studio Installer on your computer.
Select Start, and then scroll to the letter V, where it's listed as Visual Studio Installer
2. Click or tap to start the installer, and then choose "Modify"
3. From the Workloads screen, check if "Desktop Development with C++" workload is activated and
if "Windows 11 SDK" is enabled like in the following image
\image html img-win11-msvc17-config.jpg
4. Choose Modify again.
5. After the new workloads and components are installed, choose Launch.

\subsection install_win11_msvc17_3rd_cmake 1.2. CMake

CMake could be download from http://www.cmake.org. Download the latest release for Windows win64-x64
platform (at the time this tutorial was written it was the file `cmake-3.24.2-windows-arm64.msi`).
To install just double click on the msi file.

\subsection install_win11_msvc17_3rd_git 1.3. Git

Install Git for Windows from https://git-for-windows.github.io/. This installation allows then to use git
in a `cmd` Command Prompt.

\section install_win11_msvc17_ws 2. Create a workspace

If not already done, create a workspace that will contain all ViSP source, build, data set and optional
3rd parties. This workspace is here set to `C:\visp-ws` folder, but it could be set to any other location.

To create the workspace, open a `cmd` Command Prompt (a fast way to launch this window is to press the
Win + R keys on your keyboard. Then, type `cmd` or `cmd.exe` and press Enter or click/tap OK) and run
the following to create a workspace environment var named `VISP_WS`:
\verbatim
C:\> setx VISP_WS "C:\visp-ws"
C:\> exit
\endverbatim
Open a new `cmd` Command Prompt and create the corresponding folder
\verbatim
C:\> mkdir %VISP_WS%
C:\> exit
\endverbatim

\section install_win11_msvc17_quick 3. Quick ViSP installation

In this section, we give minimal instructions to build ViSP from source just to try ViSP without entering
in \ref install_win11_msvc17_advanced.

- Open a new `cmd` Command Prompt and get ViSP source code in the workspace
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp.git
\endverbatim
- Create a build directory
\verbatim
C:\> mkdir visp-build-vc17
C:\> cd visp-build-vc17
\endverbatim
- Run CMake in build directory (here the generator is chosen for Visual Studio 17 2022):
\verbatim
C:\> cmake -G "Visual Studio 17 2022" -A "x64" ..\visp
\endverbatim
- Build and install ViSP (installation doesn't need administrator privileges)
\verbatim
C:\> cmake --build . --config Release --target install
\endverbatim
- ViSP is now installed in `%%VISP_WS%\visp-build-vc17\install` folder
- Modify the `Path` var to add `%%VISP_WS%\visp-build-vc17\install\x64\vc17\bin` corresponding to the
path to ViSP libraries. To modify `Path` environment variable do the following:
  - Open the Start Search, type in "env", and choose "Edit environment variables for your account"
  - Click the "Environment Variables..." button
  - Under the "User Variables" section (the upper half), find the row with "Path" in the first column, and click edit
  - The "Edit environment variable" UI will appear.
  - Click "New" button to add a new line with `%%VISP_WS%\visp-build-vc17\install\x64\vc17\bin`

- Set `VISP_DIR` var to help CMake to find ViSP as a 3rd party
\verbatim
C:\> setx VISP_DIR "%VISP_WS%\visp-build-vc17\install"
C:\> exit
\endverbatim

To have a trial, just jump to \ref install_win11_msvc17_dataset before running some binaries that you
just build or jump to \ref install_win11_msvc17_next. You can later come back to the
\ref install_win11_msvc17_advanced.

\section install_win11_msvc17_advanced 4. Advanced ViSP installation

\subsection install_win11_msvc17_3rdparty 4.1. Install 3rd parties

ViSP is interfaced with several 3rd party libraries.
Follow the link to see the complete list of \ref supported-third-parties.
We recommend first to install \ref install_win11_msvc17_3rdparty_opencv in the workspace.
Then to use optimized matrix operations you may install \ref install_win11_msvc17_3rdparty_eigen.
Other 3rd parties are optional and should be considered only by expert developers.

\subsubsection install_win11_msvc17_3rdparty_opencv 4.1.1. OpenCV

<b>4.1.1.1. Get OpenCV</b>

First you have to get OpenCV:
- From https://opencv.org/releases/ download the latest OpenCV for Windows. In our case we got
`opencv-4.12.0-windows.exe` Win pack installer.
- Extract the content of the archive in your workspace `%%VISP_WS%/3rdparty`.
\image html img-win-extract-opencv.jpg
- The installer extract all the material in `%%VISP_WS%\3rdparty\opencv`.
- We strongly recommend to rename this folder to a name that contain OpenCV version like
  `%%VISP_WS%\3rdparty\opencv-4.12.0`.

<b>4.1.1.2. Complete OpenCV installation</b>

Now you have to complete OpenCV installation setting some environment vars:
- In order that ViSP detects OpenCV you have to set `OpenCV_DIR` environment variable. Start up a `cmd`
Command Prompt and enter:
\verbatim
C:\> setx OpenCV_DIR "%VISP_WS%\3rdparty\opencv-4.12.0\build"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\opencv-4.12.0\build` is where you have installed OpenCV. Inside this folder you should
have a file named `OpenCVConfig.cmake`.

- You have also to add the location of OpenCV libraries in the `Path` environment variable. Open the
  "Edit environment variable" UI, and modify `Path` to add a new line with
  `%%VISP_WS%\3rdparty\opencv-4.12.0\build\x64\vc16\bin`.

\subsubsection install_win11_msvc17_3rdparty_eigen 4.1.2. Eigen3

Even if Eigen3 is designed as a template we recommend to install the library with Visual Studio.

<b>4.1.2.1. Get Eigen3</b>

- Download the latest Eigen3 release from http://eigen.tuxfamily.org. At the time this tutorial was
written we downloaded `eigen-3.4.0.zip` archive corresponding to Eigen 3.4.0.
- Extract the content of the archive in `%%VISP_WS%\3rdparty`.
- Once unzipped, you should have Eigen in `%%VISP_WS%\3rdparty\eigen-3.4.0`

<b>4.1.2.2. Build and install Eigen3 from source</b>

- Create a build directory
\verbatim
C:\> cd %VISP_WS%\3rdparty\eigen-3.4.0
C:\> mkdir build-vc17 && cd build-vc17
\endverbatim
- Run CMake in build directory (here the generator is chosen for Visual Studio 17 2022 and installation folder is set
 to `%%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install` folder):
\verbatim
C:\> cmake -G "Visual Studio 17 2022" -A "x64" .. -DCMAKE_INSTALL_PREFIX=%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install
\endverbatim
- Build and install Eigen3 (installation doesn't need administrator privileges)
\verbatim
C:\> cmake --build . --config Release --target install
\endverbatim
- Eigen3 is now installed in `%%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install` folder

<b>4.1.2.3. Complete Eigen3 installation</b>

Now you have to complete Eigen3 installation setting some environment vars:
- In order that ViSP detects Eigen3 you have to set `EIGEN_DIR` environment variable. Start up a `cmd`
Command Prompt and enter:
\verbatim
C:\> setx Eigen3_DIR "%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install\share\eigen3\cmake"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install` is where you have installed Eigen3.
Inside the folder `%%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install\share\eigen3\cmake` you should have a file
named `Eigen3Config.cmake`.
- There is no need to set `Path` environment var since Eigen3 is a template that has no library.

\subsubsection install_win11_msvc17_3rdparty_realsense 4.1.3. librealsense

If you have an RealSense Depth camera (SR300 or D400 series), you may install librealsense 2.x in order to use
vpRealSense2 class. Otherwise you can skip this section.

<b>4.1.3.1. Install Realsense SDK 2.0</b>

Realsense SDK 2.0 contains librealsense. To install this SDK:
- Go to https://github.com/realsenseai/librealsense/releases
- Download `RealSense.SDK-WIN10-<version>.exe` corresponding to the last Realsense SDK 2.0 release.
  At the time this tutorial was written, we downloaded `RealSense.SDK-WIN10-2.57.3.9476.exe`.
- Execute `RealSense.SDK-WIN10-<version>.exe`, then set destination folder to `%%VISP_WS%\3rdparty\RealSense SDK 2.0`
  and follow default installation steps.

<b>4.1.3.2. Complete Realsense SDK 2.0 installation</b>

Now you have to complete Realsense SDK installation setting some environment vars:
- In order that ViSP detects Realsense SDK you have to set `REALSENSE2_DIR` environment variable. Start up a `cmd`
Command Prompt and enter:
\verbatim
C:\> setx REALSENSE2_DIR "%VISP_WS%\3rdparty\RealSense SDK 2.0"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\RealSense SDK 2.0` is where you have installed Realsense SDK 2.0. Inside this folder you
should find Realsense library in `lib/x64/`.

- You have also to add the location of `realsense2.dll` library in the `Path` environment variable. Open the
  "Edit environment variable" UI, and modify `Path` to add a new line with
  `%%VISP_WS%\3rdparty\RealSense SDK 2.0\bin\x64`.

\subsubsection install_win11_msvc17_3rdparty_json 4.1.4. Nlohmann JSON

<a href="https://json.nlohmann.me/">JSON for modern C++</a> installation, can either be done from source
or from a package manager
  - To install from source with Visual Studio
\verbatim
C:\> cd %VISP_WS%\3rdparty
C:\> git clone https://github.com/nlohmann/json.git
C:\> cd json && mkdir build-vc17 && cd build-vc17
C:\> cmake -G "Visual Studio 17 2022" -A "x64" .. -DCMAKE_INSTALL_PREFIX=%VISP_WS%\3rdparty\json\build-vc17\install -DJSON_BuildTests=OFF
C:\> cmake --build . --config Release --target install
\endverbatim
  JSON is now installed in `%%VISP_WS%\3rdparty\json\build-vc17\install` folder.
  Now in order that ViSP detects JSON you have to set `nlohmann_json_DIR` environment variable.
  Start up a `cmd` Command Prompt and enter:
\verbatim
C:\> setx nlohmann_json_DIR "%VISP_WS%\3rdparty\json\build-vc17\install\share\cmake\nlohmann_json"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\json\build-vc17\install` is where you have installed JSON.
Inside the folder `%%VISP_WS%\3rdparty\json\build-vc17\install\share\cmake\nlohmann_json` you should have a file
named `nlohmann_jsonConfig.cmake`.
There is no need to set `Path` environment var since JSON has only a header and no library.

  - To install from a package manager, e.g., vcpkg, see: <a href="https://json.nlohmann.me/integration/package_managers/#embedded">https://json.nlohmann.me/integration/package_managers/#embedded</a>

\subsection install_win11_msvc17_get_source 4.2. Get ViSP source code

There are different ways to get ViSP source code.

- You can download the <a href="https://visp.inria.fr/download">latest release</a> as a zip or a tarball.
  Once `visp-x.y.z.tar.gz` or `visp-x.y.z.zip` is downloaded, uncompress the file in `%%VISP_WS%\visp\visp-x.y.z`
  using for example <a href="http://www.win-rar.com">WinRAR</a>.

- You can also download a <a href="https://visp.inria.fr/download#snapshot">daily snapshot</a>.
  Once `visp-snapshot-yyyy-mm-dd.tar.gz` is downloaded, uncompress the file in `%%VISP_WS%\visp\visp-x.y.z`
  using for example <a href="http://www.win-rar.com">WinRAR</a>.

- Or you get the cutting-edge ViSP from <a href="https://github.com/lagadic/visp">GitHub repository</a>
  using the `git` command line tool:
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp.git
\endverbatim

We suppose now that ViSP source is in `%%VISP_WS%\visp`.

\subsection install_win11_msvc17_config 4.3. Configure ViSP from source

The goal of the configuration step is now to use CMake to produce a Visual Studio C++ solution file that
will be located in `%%VISP_WS%/visp-build-vc17`.

- Launch CMake (cmake-gui) and complete the source code and binaries location as in the next image.
\image html img-cmake-win11-msvc17-visp-launch.jpg
- Click then on "Configure" button.
\image html img-cmake-win10-msvc17-visp-create-folder.jpg
- Click on "Yes" to create the `%%VISP_WS%/visp-build-vc17` folder.
- Select then your compiler "Visual Studio 17 2022" and click on "Finish" button.
\image html img-cmake-win10-msvc17-msvc-version.jpg
- This will start CMake configuration. As shown in the next image, Eigen3, GDI (Graphical
  Device Interface), OpenCV and OpenMP 3rd parties are automatically detected.
\image html img-cmake-win11-msvc17-visp-config.jpg
\note Installation folder is set to `%%VISP_WS%/visp-build-vc17/install`. If you want to change the
installation folder to `C:\Program Files (x86)\ViSP`, make sure that you have administrator privileges
to write in that folder before modifying `CMAKE_INSTALL_PREFIX`.
\warning If you forgot to set `Eigen3_DIR` environment var, you will get the following warning in `cmake_gui`:
\verbatim
CMake Warning at CMakeLists.txt:1156 (message):
  Eigen3 config file is detected in C:/visp-ws/3rdparty/eigen-3.4.0/build-vc17.  Using
  C:/visp-ws/3rdparty/eigen-3.4.0/build-vc17/Eigen3Config.cmake doesn't allow to use a
  valid Eigen3 include dir: C://include/eigen3.  Modify Eigen3_DIR to point
  to Eigen3Config.cmake file located in Eigen3 installation folder or turn
  USE_EIGEN3 OFF.
\endverbatim
We strongly recommend to fix this warning. To this end:
  - close `cmake-gui`
  - set `Eigen3_DIR` environment var running
    `setx Eigen3_DIR "%VISP_WS%\3rdparty\eigen-3.4.0\build-vc17\install\share\eigen3\cmake"`
  - open again `cmake-gui`
  - delete the cache using menu `File > Delete Cache`
  - and configure again ViSP.
  .
At this point, you should no more see the warning.

- Click then on "Configure" button. All the red lines should disappear.
\note The default configuration lead to the creation of a shared library (with `.dll` extension). This is
the default configuration that is recommended. If you want to create rather a static library
(with `.lib` extension) you have to uncheck the `BUILD_SHARED_LIBS` option to disable DLL creation.

- To finish the configuration, click on "Generate" button.

- Once the generation is done, in `%%VISP_WS%/visp-build-vc17` folder you have the Visual Studio
`VISP.sln` generated solution file.

\subsection install_win11_msvc17_build 4.4. Build and install ViSP

- To build ViSP just double click on `%%VISP_WS%/visp-build-vc17/VISP.sln` solution file. This action
will open ViSP project in Visual Studio C++. By default, Visual Studio opens the solution in `Debug`
configuration. Modify the configuration to `"Release"`.
\image html img-win11-msvc17-visp-open.jpg

- Enter menu `"Build > Build Solution"` to build ViSP or hit "Ctrl+Maj+B".

- At the end of the build process you should have the following indicating that all the build succeeded.
\image html img-win11-msvc17-visp-build-end.jpg

- Now to install ViSP, in the right panel, deploy `"CMakeTargets"` and build `"INSTALL"` project. To this end, apply a left click on `"INSTALL"` to select
the `"INSTALL"` project, then a right click to enter in the "Build" menu. At the end of the installation, you should have the following.
\image html img-win11-msvc17-visp-install-end.jpg

- As shown in the previous image, all the headers but also the generated libraries are copied in
`%%VISP_WS\visp-build-vc17\install` folder; headers and libraries in `include` and `x64/vc17`
subfolders respectively.

- This ends ViSP installation in `"Release"` configuration. Now in
`%%VISP_WS%/visp-build-vc17/install/x64/vc17/bin` folder you have ViSP DLL libraries corresponding to ViSP modules.
\image html img-win11-msvc17-visp-explorer-install.jpg

- Note that you can also build ViSP in `Debug` configuration. In that case, all the library names are suffixed
by "d" character (`libvisp_core351d.dll`...).

\subsection install_win11_msvc17_build_visp_doc 4.5. Build ViSP documentation

To build ViSP documentation, you have first to install [Doxygen](http://www.doxygen.nl):
- [Download](http://www.doxygen.nl/download.html) binary distribution for Windows. At the time this tutorial
was written, we downloaded `doxygen-1.9.4-setup.exe`
- Run the installer following default options
- Open a new `cmd` Command Prompt and enter build directory
\verbatim
C:\> cd %VISP_WS%\visp-build-vc17
\endverbatim
- Run CMake in build directory:
\verbatim
C:\> cmake -G "Visual Studio 17 2022" -A "x64" %VISP_WS%\visp
\endverbatim
- Build documentation using:
\verbatim
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

The generated documentation is then available in `$VISP_WS/visp-build-vc17/doc/html/index.html`

\note
- To speed up generating online doc, particularly around formula rendering, you can use
[MatJax](https://www.mathjax.org). To this end, install first `npm` LTS version following these
[instructions](https://www.npmjs.com/get-npm), then install MathJax and build doc using:
\verbatim
C:\> npm install mathjax
C:\> cmake -G "Visual Studio 17 2022" -A "x64" %VISP_WS%\visp -DUSE_MATHJAX=ON
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

- It is also possible to generate a more complete documentation that includes also all the
internal classes. This could be achieved setting CMake var `ENABLE_FULL_DOC` to `ON` like:
\verbatim
C:\> cmake -G "Visual Studio 17 2022" -A "x64" %VISP_WS%\visp -DENABLE_FULL_DOC=ON
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

\subsection install_win11_msvc17_env_var 4.6. Set Path environment var

Modify the `Path` var to add the path to ViSP dll libraries. To this end open the "Edit environment variable" UI,
and modify `Path` to add a new line with `%%VISP_WS%\visp-build-vc17\install\x64\vc17\bin`.

\subsection install_win11_msvc17_visp_dir 4.7. Set VISP_DIR environment var

In order to ease ViSP detection by CMake when ViSP is used as a 3rd party in an external project, like the one
described in the \ref tutorial-getting-started, you may set `VISP_DIR` environment variable with the path
to the `VISPConfig.cmake` file:
\verbatim
C:\> setx VISP_DIR "%VISP_WS%\visp-build-vc17\install"
C:\> exit
\endverbatim

\section install_win11_msvc17_dataset 5. Install ViSP data set

Some ViSP examples and tests require a data set that contains images, video, models that is not part of
ViSP source code. This data set is available in Github (https://github.com/lagadic/visp-images) or as a
release in a separate archive named `visp-images-x.y.z.zip`. This archive could be downloaded from
https://visp.inria.fr/download page. Note that ViSP tutorials are not using ViSP data set.

We give hereafter the two ways to get this data set:

\subsection install_win11_msvc17_dataset_release 5.1. Get data set release

- Download the latest `visp-images-3.x.y.zip` from https://visp.inria.fr/download and uncompress it in your workspace
`%%VISP_WS%`.
\image html img-win-visp-images-last-release.jpg
- Once downloaded, you need to set `VISP_INPUT_IMAGE_PATH` environment variable to help ViSP examples
and tests to detect automatically the location of the requested data. In our case, this variable should
be set to `%%VISP_WS%\visp-images-3.6.0`. Open a `cmd` Command Prompt and run
\verbatim
C:\> setx VISP_INPUT_IMAGE_PATH %VISP_WS%\visp-images-3.6.0
C:\> exit
\endverbatim

\subsection install_win11_msvc17_dataset_github 5.2. Get data set from github

- Use git to get the data set latest version:
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp-images.git
\endverbatim
\image html img-win-visp-images-git.jpg
- Once cloned, you need to set `VISP_INPUT_IMAGE_PATH` environment variable to help ViSP examples and tests
to detect automatically the location of the requested data. In our case, this variable should be set to
`%%VISP_WS%\visp-images`. Open a `cmd` Command Prompt and run
\verbatim
C:\> setx VISP_INPUT_IMAGE_PATH %VISP_WS%\visp-images
C:\> exit
\endverbatim

\subsection install_win11_msvc17_dataset_test 5.3. Test data set usage

From now, you can try to run ViSP examples and tests. For example, if you want to run
`%%VISP_WS%\visp-build-vc17\example\device\display\Release\displayGDI.exe`, open a `cmd` Command Prompt,
enter in the right folder and run:
\verbatim
C:\> cd %VISP_WS%\visp-build-vc17\example\device\display\Release
C:\> displayGDI.exe

A click to close the windows...

A click to display a cross...
Cross position: 392, 306

A click to exit the program...
Bye
\endverbatim

\note At this point, if it opens a popup saying that `libvisp_io.dll` was not found like in the following
image it means either that you didn't add the location of ViSP dll libraries in the path environment variable
(see \ref install_win11_msvc17_env_var section), or that the path that you added is wrong.
\image html img-win11-error-displayGDI-visp-path.jpg

\note At this point, if it opens a popup saying that `libopencv_core.dll` was not found like in the following
image it means either that you didn't add the location of OpenCV dll libraries in the path environment variable
(see \ref install_win11_msvc17_3rdparty_opencv section), or that the path that you added is wrong.
\image html img-win11-error-displayGDI-opencv-path.jpg

\section install_win11_msvc17_tips 6. Tips and tricks

\subsection install_win11_msvc17_tips_new_3rdparty 6.1. How to take into account a newly installed 3rd party

Since all 3rd parties are optional you may have started to install only some of them. Imagine that you just
installed a new third-party, or that you upgraded the version of this 3rd party. The next step is to go back
to the build folder, configure ViSP with CMake to detect the newly installed third-party library and build
again ViSP. This could be achieved with:
\verbatim
C:\> cd $VISP_WS/visp-build-msvc17
C:\> cmake ../visp
\endverbatim

Here you can check the content of the `ViSP-third-party.txt` file and see if the newly installed 3rd party
is well detected.

Finally, you need to rebuild and install ViSP with:
\verbatim
C:\> cmake --build . --config Release --target install
\endverbatim

\subsection install_win11_msvc17_tips_uninstall 6.2. How to uninstall ViSP
After ViSP installation, you can remove installed material using:
\verbatim
C:\> cd $VISP_WS/visp-build-msvc17
C:\> cmake --build . --config Release --target uninstall
\endverbatim

\subsection install_win11_msvc17_tips_modules 6.3. How to build only ViSP libraries

If you want to build only ViSP modules libraries, nor the examples, tutorials and tests:
\verbatim
C:\> cd $VISP_WS/visp-build-msvc17
C:\> cmake --build . --config Release --target visp_modules
\endverbatim

\subsection install_win11_msvc17_tips_module_once 6.4. How to build a ViSP specific module

If you want to build a given module and all the dependencies:
\verbatim
C:\> cd $VISP_WS/visp-build-msvc17
C:\> cmake --build . --config Release --target visp_<module_name>
\endverbatim

For example to build the model-based tracker module named mbt, run:
\verbatim
C:\> cd $VISP_WS/visp-build-msvc17
C:\> cmake --build . --config Release --target visp_mbt
\endverbatim

\subsection install_win11_msvc17_tips_3rd_party 6.5. Which are the 3rd party libraries that are used in ViSP ?

To see which are the optional 3rd parties that are found during the configuration stage and that will
be used by ViSP during the build you can have a look to the text file named `ViSP-third-party.txt` and
located in `$VISP_WS/visp-build-vc17`. We provide hereafter an example of a possible content of this file
that contains also build info.
\verbatim
C:\> type $VISP_WS/visp-build-vc17/ViSP-third-party.txt
==========================================================
General configuration information for ViSP 3.5.1

  Version control:               v3.5.0-193-g039940ad2-dirty

  Platform:
    Timestamp:                   2022-10-02T11:14:47Z
    Host:                        Windows 10.0.22598 ARM64
    CMake:                       3.24.2
    CMake generator:             Visual Studio 17 2022
    CMake build tool:            C:/Program Files/Microsoft Visual Studio/2022/Community/MSBuild/Current/Bin/arm64/MSBuild.exe
    MSVC:                        1933

  System information:
    Number of CPU logical cores: 8
    Number of CPU physical cores: 8
    Total physical memory (in MiB): 10232
    OS name:                     Windows
    OS release:                  Professional
    OS version:                  (Build 22598)
    OS platform:                 ARM64
    CPU name:
    Is the CPU 64-bit?           yes
    Does the CPU have FPU?       no
    CPU optimization:            SSE2 SSE3 SSSE3 SSE4_1 SSE4_2

  C/C++:
    Built as dynamic libs?:      yes
    C++ Compiler:                C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.33.31629/bin/HostARM64/x64/cl.exe  (ver 19.33.31630.0)
    C++ flags (Release):         /DWIN32 /D_WINDOWS /W3 /GR /EHsc /MP8   /EHa -openmp /Gy /bigobj /MD /O2 /Ob2 /DNDEBUG
    C++ flags (Debug):           /DWIN32 /D_WINDOWS /W3 /GR /EHsc /MP8   /EHa -openmp /Gy /bigobj /MDd /Zi /Ob0 /Od /RTC1
    C Compiler:                  C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.33.31629/bin/HostARM64/x64/cl.exe
    C flags (Release):           /DWIN32 /D_WINDOWS /W3   /MP8   /EHa -openmp /MD /O2 /Ob2 /DNDEBUG
    C flags (Debug):             /DWIN32 /D_WINDOWS /W3   /MP8   /EHa -openmp /MDd /Zi /Ob0 /Od /RTC1
    Linker flags (Release):      /machine:x64 /INCREMENTAL:NO
    Linker flags (Debug):        /machine:x64 /debug /INCREMENTAL /ignore:4099
    Use cxx standard:            17

  ViSP modules:
    To be built:                 core gui imgproc io java_bindings_generator klt me sensor ar blob robot visual_features vs vision detection mbt tt tt_mi
    Disabled:                    -
    Disabled by dependency:      -
    Unavailable:                 java

  Windows RT support:            no

  Python (for build):            no

  Java:
    ant:                         no
    JNI:                         no

  Build options:
    Build deprecated:            yes
    Build with moment combine:   no

  Mathematics:
    Blas/Lapack:                 yes
    \- Use MKL:                  no
    \- Use OpenBLAS:             no
    \- Use Atlas:                no
    \- Use Netlib:               no
    \- Use GSL:                  no
    \- Use Lapack (built-in):    yes (ver 3.2.1)
    Use Eigen3:                  yes (ver 3.4.0)
    Use OpenCV:                  yes (ver 4.6.0)

  Simulator:
    Ogre simulator:
    \- Use Ogre3D:               no
    \- Use OIS:                  no
    Coin simulator:
    \- Use Coin3D:               no
    \- Use SoWin:                no
    \- Use SoXt:                 no
    \- Use SoQt:                 no
    \- Use Qt5:                  no
    \- Use Qt4:                  no
    \- Use Qt3:                  no

  Media I/O:
    Use JPEG:                    no
    Use PNG:                     no
    \- Use ZLIB:                 no
    Use OpenCV:                  yes (ver 4.6.0)
    Use stb_image (built-in):    yes (ver 2.27.0)

  Real robots:
    Use Afma6:                   no
    Use Franka:                  no
    Use Viper650:                no
    Use Viper850:                no
    Use ur_rtde:                 no
    Use Kinova Jaco:             no
    Use aria (Pioneer):          no
    Use PTU46:                   no
    Use Biclops PTU:             no
    Use Flir PTU SDK:            no
    Use MAVSDK:                  no
    Use Parrot ARSDK:            no
    \-Use ffmpeg:                no
    Use Virtuose:                no
    Use qbdevice (built-in):     yes (ver 2.6.0)
    Use takktile2 (built-in):    no

  GUI:
    Use X11:                     no
    Use GTK:                     no
    Use OpenCV:                  yes (ver 4.6.0)
    Use GDI:                     yes
    Use Direct3D:                no

  Cameras:
    Use DC1394-2.x:              no
    Use CMU 1394:                no
    Use V4L2:                    no
    Use directshow:              no
    Use OpenCV:                  yes (ver 4.6.0)
    Use FLIR Flycapture:         no
    Use Basler Pylon:            no
    Use IDS uEye:                no

  RGB-D sensors:
    Use Realsense:               no
    Use Realsense2:              no
    Use Occipital Structure:     no
    Use Kinect:                  no
    \- Use libfreenect:          no
    \- Use libusb-1:             no
    \- Use pthread:              no
    Use PCL:                     no
    \- Use VTK:                  no

  F/T sensors:
    Use atidaq (built-in):       no
    Use comedi:                  no
    Use IIT SDK:                 no

  Mocap:
    Use Qualisys:                no
    Use Vicon:                   no

  Detection:
    Use zbar:                    no
    Use dmtx:                    no
    Use AprilTag (built-in):     yes (ver 3.1.1)
    \- Use AprilTag big family:  no

  Misc:
    Use Clipper (built-in):      yes (ver 6.4.2)
    Use pugixml (built-in):      yes (ver 1.9.0)
    Use libxml2:                 no

  Optimization:
    Use OpenMP:                  yes
    Use pthread:                 no
    Use pthread (built-in):      yes (ver 3.0.1)
    Use Simd:                    yes (ver 4.9.109)

  DNN:
    Use CUDA Toolkit:            no
    Use TensorRT:                no

  Documentation:
    Use doxygen:                 yes
    \- Use mathjax:              no

  Tests and samples:
    Use catch2 (built-in):       yes (ver 2.13.7)
    Tests:                       yes
    Demos:                       yes
    Examples:                    yes
    Tutorials:                   yes

  Install path:                  C:/visp-ws/visp-build-vc17/install

==========================================================
\endverbatim

\section install_win11_msvc17_next 7. Next tutorial

You are now ready to see the next \ref tutorial-getting-started that will show you how to use ViSP as a
3rd party to build your own project.

*/