dalihub / dali-core

DALi's Core library contains essential features e.g. the scene-graph, animation & rendering systems.

Table of Contents

• Build Instructions
  • 1. Building for Ubuntu desktop
    • Minimum Requirements
    • Creating a DALi Environment
    • Building the Repository
    • Building and executing test cases
  • 2. GBS Builds
    • NON-SMACK Targets
    • SMACK enabled Targets
    • DEBUG Builds
  • 3. Building for MS Windows
    • Build with the Visual Studio project
    • Build with CMake
  • 4. Building for macOS
    • macOS Dependencies
    • Build the repository

Build Instructions

1. Building for Ubuntu desktop

Minimum Requirements

• Ubuntu 20.04 or later
• GCC version 9
• Cmake version 3.8.2 or later

DALi requires a compiler supporting C++17 features.

Creating a DALi Environment

To build for desktop first ensure ALL sources are selected:

• Go to Ubuntu Settings and then to "Software & Updates"

• In the "Ubuntu Software" tab, ensure ALL software sources are ticked (This is required because we install some community-maintained free & open-source software)

• Install Perl Recursive support:

    $ sudo apt install libfile-copy-recursive-perl
  

Then you can create a dali-env folder in your home folder with:

     $ dali-core/build/scripts/dali_env -c

This will also download any dependencies that the dali repositories require.

You can save the environment variables to a file:

     $ dali-env/opt/bin/dali_env -s > setenv

This process only needs to be done once.

Next source these variables:

     $ . setenv

You will have to source these variables every time you open up a new terminal (or you can add to .bashrc if you prefer).

Building the Repository

To build the repository enter the 'build/tizen' folder:

     $ cd dali-core/build/tizen

Then run the following command to set up the build:

     $ cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX .

If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug

To build run:

     $ make install -j8

Building and executing test cases

See the README.md in dali-core/automated-tests.

2. GBS Builds

NON-SMACK Targets

     $ gbs build -A [TARGET_ARCH]

SMACK enabled Targets

     $ gbs build -A [TARGET_ARCH] --define "%enable_dali_smack_rules 1"

DEBUG Builds

     $ gbs build -A [TARGET_ARCH] --define "%enable_debug 1"

3. Building for MS Windows

Third party dependencies are built using vcpkg. Instructions on how to install vcpkg can be found in the vcpkg-script folder in the windows-dependencies repository.

• Download the windows-dependencies repository from DaliHub

     $ git clone https://github.com/dalihub/windows-dependencies.git
  

• Read the windows-dependencies/vcpkg-script/Readme.md file for more instructions on how to build and install the third-party dependencies.

Build with the Visual Studio project

Read the windows-dependencies/README.md file for more instructions on how to build and run DALi for MS Windows.

Build with CMake

• Requirements It's required the version 3.12.2 of CMake and a Git Bash Shell.

• Notes and troubleshoting: It should be possible to use the MS Visual studio Developer Command Prompt (https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs) to build DALi from the command line. However, the CMake version installed with MS Visual Studio 2017 is a bit out of date and some VCPKG modules require a higher version. This instructions have been tested with CMake 3.12.2 on a Git Bash shell.

• Define an environment variable to set the path to the VCPKG folder

  $ export VCPKG_FOLDER=C:/Users/username/Workspace/VCPKG_TOOL

• Define an environment variable to set the path where DALi is going to be installed.

  $ export DALI_ENV_FOLDER=C:/Users/username/Workspace/dali-env

• Execute the following commands to create the makefiles, build and install DALi.

  $ cmake -g Ninja . -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/vcpkg/scripts/buildsystems/vcpkg.cmake -DENABLE_PKG_CONFIGURE=OFF -DENABLE_LINK_TEST=OFF -DCMAKE_INSTALL_PREFIX=$DALI_ENV_FOLDER -DINSTALL_CMAKE_MODULES=ON $ cmake --build . --target install

• Options:

  • CMAKE_TOOLCHAIN_FILE ---> Needed to find packages installed by VCPKG.
  • ENABLE_PKG_CONFIGURE ---> Whether to install pkg configure files (not currently working on MS Windows. CMake modules used instead).
  • ENABLE_LINK_TEST ---> Whether to enable the link test (not currently working on MS Windows).
  • CMAKE_INSTALL_PREFIX ---> Were DALi is installed.
  • INSTALL_CMAKE_MODULES ---> Whether to install the CMake modules (Used by the CMake command find_package() to find previously installed libraries).
  • ENABLE_DEBUG ---> Whether to build with debug enabled.

4. Building for macOS

macOS Dependencies

Ensure you have followed the instructions in the macos-dependencies repo here to create the DALi environment on the macOS. You can clone it using:

% git clone https://github.com/dalihub/macos-dependencies.git

Build the repository

To build the repository enter the 'build/tizen' folder:

% cd dali-core/build/tizen

Then run the following command to set up the build:

% cmake -DCMAKE_INSTALL_PREFIX=$DESKTOP_PREFIX -DCMAKE_TOOLCHAIN_FILE=$VCPKG_FOLDER/scripts/buildsystems/vcpkg.cmake -DINSTALL_CMAKE_MODULES=ON

If a Debug build is required, then add -DCMAKE_BUILD_TYPE=Debug -DENABLE_DEBUG=ON

To build run:

% make install -j8