Visual Servoing Platform  version 3.5.0 under development (2022-02-15)
Tutorial: Cross-compilation for UWP from Windows host with Visual C++ 2015 (vc14)

Table of Contents

In this tutorial you will learn how to build ViSP framework for Universal Windows Platform (UWP) to include ViSP functionalities in apps developments that target a wide range of devices including PC, mobile, Xbox, HoloLens, IoT, and Surface Hub.

This tutorial has been tested on Windows 10 (64 bit), with CMake 3.13.1 and Visual Studio 2015.

Note
Concerning ViSP installation, we provide also other Tutorials for ViSP users.

Install prerequisites

Visual Studio

Install Visual Studio 2015. Make sure that the Universal Windows App Development Tools are selected from the optional features list. Without these tools, you won't be able to create your universal apps. After the installation, start Visual Studio and create an empty C++ project to install the common tools for Visual C++ 2015.

Note
If you have already Visual Studio 2015 installed and don't know if the Universal Windows App Development Tools are enabled see How to add Universal Windows App Development Tools support.

After installing Visual Studio software, you need to enable your Windows 10 device for development.

CMake

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

Git

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

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: 

C:\> setx VISP_WS "C:\visp-ws"
C:\> exit

Open a new cmd Command Prompt and create the corresponding folder 

C:\> mkdir %VISP_WS%
C:\> exit

Get ViSP source code

There are different ways to get ViSP source code.

  • You can download the latest release 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 WinRAR.
  • You can also download a daily snapshot. Once visp-snapshot-yyyy-mm-dd.tar.gz is downloaded, uncompress the file in %VISP_WS%\visp\visp-x.y.z using for example WinRAR.
  • Or you get the cutting-edge ViSP from GitHub repository using the git command line tool: 
    C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp.git

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

Build ViSP

Build for Windows Store 10.0

Targeting a x86 platform

With CMake configure ViSP specifying options for cross compiling for "Windows Store" operating system in version "10" targeting a "x86" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-10-x86
C:\> cd visp-build-vc14-uwp-ws-10-x86
C:\> cmake.exe -G "Visual Studio 14 2015" -A "Win32" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="10.0" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF   \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                       \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-ws-10-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-10-install folder. Libraries are located in x86/vc14/bin subfolder and headers in include subfolder.

Targeting a x64 platform

The same process could be applied except that during cmake configuration you have to use "Visual Studio 14 2015 Win64" generator. Installation folder is the same to ensure a unique installation folder for all the targeted platforms:

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-10-x64
C:\> cd visp-build-vc14-uwp-ws-10-x64
C:\> cmake.exe -G "Visual Studio 14 2015" -A "x64" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="10.0" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-ws-10-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-10-install folder. Libraries are located in x64/vc14/bin subfolder and headers in include subfolder.

Targeting an ARM platform

The same process could be applied except that during cmake configuration you have to use "Visual Studio 14 2015 ARM" generator. Installation folder is the same to ensure a unique installation folder for all the targeted platforms:

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-10-arm
C:\> cd visp-build-vc14-uwp-ws-10-arm
C:\> cmake.exe -G "Visual Studio 14 2015" -A "ARM" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="10.0" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc15-uwp-ws-10-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-10-install folder. Libraries are located in ARM/vc14/bin subfolder and headers in include subfolder.

Build for Windows Store 8.1

Targeting a x86 platform

With CMake configure ViSP specifying options for cross compiling for "Windows Store" operating system in version "8.1" targeting a "x86" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-8.1-x86
C:\> cd visp-build-vc14-uwp-ws-8.1-x86
C:\> cmake.exe -G "Visual Studio 14 2015" -A "Win32" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF    \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                       \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-ws-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-8.1-install folder. Libraries are located in x86/vc14/bin subfolder and headers in include subfolder.

Targeting a x64 platform

With CMake configure ViSP specifying options for cross compiling for "Windows Store" operating system in version "8.1" targeting a "x64" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-8.1-x64
C:\> cd visp-build-vc14-uwp-ws-8.1-x64
C:\> cmake.exe -G "Visual Studio 14 2015" -A "x64" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF  \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-ws-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-8.1-install folder. Libraries are located in x64/vc14/bin subfolder and headers in include subfolder.

Targeting an ARM platform

With CMake configure ViSP specifying options for cross compiling for "Windows Store" operating system in version "8.1" targeting a "ARM" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-ws-8.1-arm
C:\> cd visp-build-vc14-uwp-ws-8.1-arm
C:\> cmake.exe -G "Visual Studio 14 2015" -A "ARM" -DCMAKE_SYSTEM_NAME:String=WindowsStore \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF  \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-ws-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-ws-8.1-install folder. Libraries are located in ARM/vc14/bin subfolder and headers in include subfolder.

Build for Windows Phone 8.1

Targeting a x86 platform

With CMake configure ViSP specifying options for cross compiling for "Windows Phone" operating system in version "8.1" targeting a "x86" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-wp-8.1-x86
C:\> cd visp-build-vc14-uwp-wp-8.1-x86
C:\> cmake.exe -G "Visual Studio 14 2015" -A "Win32" -DCMAKE_SYSTEM_NAME:String=WindowsPhone \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF    \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                       \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-wp-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-wp-8.1-install folder. Libraries are located in x86/vc14/bin subfolder and headers in include subfolder.

Targeting a x64 platform

With CMake configure ViSP specifying options for cross compiling for "Windows Phone" operating system in version "8.1" targeting a "x64" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-wp-8.1-x64
C:\> cd visp-build-vc14-uwp-wp-8.1-x64
C:\> cmake.exe -G "Visual Studio 14 2015" -A "x64" -DCMAKE_SYSTEM_NAME:String=WindowsPhone \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF  \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-wp-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-wp-8.1-install folder. Libraries are located in x64/vc14/bin subfolder and headers in include subfolder.

Targeting an ARM platform

With CMake configure ViSP specifying options for cross compiling for "Windows Phone" operating system in version "8.1" targeting a "ARM" platform, by opening a cmd Command Prompt and running: 

C:\> cd %VISP_WS%
C:\> mkdir visp-build-vc14-uwp-wp-8.1-arm
C:\> cd visp-build-vc14-uwp-wp-8.1-arm
C:\> cmake.exe -G "Visual Studio 14 2015" -A "ARM" -DCMAKE_SYSTEM_NAME:String=WindowsPhone \
               -DCMAKE_SYSTEM_VERSION:String="8.1" -DBUILD_DEMOS=OFF -DBUILD_EXAMPLES=OFF  \
               -DBUILD_TESTS=OFF -DBUILD_TUTORIALS=OFF                                     \
               -DCMAKE_INSTALL_PREFIX=%VISP_WS%\visp-build-vc14-uwp-wp-8.1-install ..\visp
C:\> cmake --build . --config Release --target install

If everything goes right you will find ViSP libraries and headers in %VISP_WS%/visp-build-vc14-uwp-wp-8.1-install folder. Libraries are located in ARM/vc14/bin subfolder and headers in include subfolder.

Tips and tricks

How to add Universal Windows App Development Tools support

In case you're trying to build Windows Store and Windows Phone 10.0 projects having only default Visual Studio 2015 installation you'll likely get the following error during cmake run: 

A Windows Store component with CMake requires both the Windows Desktop SDK
as well as the Windows Store '10.0' SDK. Please make sure that you have
both installed

Resolution consists in:

  • On the Start menu select Settings
  • Select System > Apps & features.
  • Select Microsoft Visual Studio 2015 program, and right click to modify installation
    img-uwp-msvc-modify.png
  • Select Modify
    img-uwp-msvc-modify2.png
  • Enable "Universal Windows App Development Tools" and "Windows 8.1 and Windows Phone 8.0/8.1 Tools"
    img-uwp-msvc-modify3.png
  • Select Update button