NoesisGUI

Getting Started with NoesisGUI C++ SDK

The aim of this tutorial is to get you started with the NoesisGUI C++ SDK and its directory structure. You will learn to build, configure and begin using the SDK to create high-performance native applications.

In the root directory of the SDK you can find XamlPlayer, a useful tool to quickly do your first UI experiments.

NOTE

In the root directory you can also find 'SDKBrowser', an application that will give you a quick overview of the SDK

Building Samples

All provided samples in the SDK, including the Application Framework, comes with full source. There is a solution for each platform inside the 'NoesisSDK/Build/' directory for building all the examples. For example, Visual Studio solution for 64-bits can be found at 'NoesisSDK/Build/NoesisGUI-win-x86_64.sln'.

Each sample also contains a Blend solution inside its 'Data' folder. For example, the Blend project for the Menu3D sample is located at 'NoesisSDK/Src/Packages/Samples/Menu3D/Data/Menu3D-blend.sln'.

NOTE

Source code for each sample is also available on GitHub. We are happy to accept pull requests.

Three configurations are available for each project:

  • Debug: with asserts, logging, instrumentation and inspector enabled.
  • Profile: fully optimized, minimal logging, instrumentation and inspector enabled.
  • Release: fully optimized, LTO in many platforms.

Building Windows / UWP

Visual Studio 2015+ is needed. Just open the solution (.sln) and build the desired configuration.

Building macOS / iOS

XCode 11.4+ is needed. Just open the workspace (.xcworkspace) and build the desired configuration.

Building Linux

Make sure to install GL and X11 headers:

> sudo apt-get install mesa-common-dev libx11-dev

With all prerequisites satisfied just build the generated makefile (.mk) for the desired configuration.

> make -f NoesisGUI-linux-x86_64.mk CONFIG=Release

Building WebGL

Make sure 'emcc', 'em++' and 'emar' are available from the command promp and just build the makefile (.mk) for the desired configuration.

> make -f NoesisGUI-wasm.mk CONFIG=Release

Building Android

Path Version Description Location
build-tools;30.0.2 30.0.2 Android SDK Build-Tools 30.0.2 build-tools30.0.2
ndk-bundle 22.1.7171670 NDK ndk-bundle
patcher;v4 1 SDK Patch Applier v4 patcherv4
platform-tools 31.0.2 Android SDK Platform-Tools platform-tools
platforms;android-30 3 Android SDK Platform 30 platformsandroid-30
tools 26.1.1 Android SDK Tools 26.1.1 tools
  • The following environment variables must be set:
  • ANDROID_NDK must point to NDK (eg: C:\Android\SDK\ndk-bundle)
  • ANDROID_PLATFORM to must point to SDK Platform (eg: C:\Android\SDK\platforms\android-17)
  • JAVA_HOME must point to Java installation path (eg: C:\Program Files\Java\jdk1.8.0_192)
  • The following binaries must be available in 'PATH' enviroment variable
  • Toolchain (clang++, clang)
  • javac
  • dx, aapt, zipalign, apksigner (Android Build Tools)

With all prerequisites satisfied just build the generated makefile (.mk) for the desired configuration.

> make -f NoesisGUI-android-arm.mk CONFIG=Release

Running Samples

Binaries are generated in 'NoesisSDK/Bin/'. There is one sub-folder for each supported platform. For example, Menu3D sample for Windows 64-bits will be generated at 'NoesisSK/Bin/windows_x86_64/Samples.Menu3D.exe'.

All our samples are built using the Application Framework and support common functionality like:

  • The following command line switches:
    • --render [D3D11|GL|Metal|...]: overrides the default renderer.
    • --vsync [0|1]: disables vertical synchronization.
    • --samples N: enables multisample anti-aliasing (MSAA), by default it is off.
    • --ppaa [0|1]: enables cheap antialiasing anti-aliasing (enabled by default).
    • --linear: for switching to linear rendering, by default rendering happens in gamma space.
    • --lcd [0|1]: enables subpixel rendering compatible with LCD displays.
    • --log_binding: to increase the verbosity of logging when using data binding.
    • --emulate_touch: enables emulation of touch input from mouse events.
  • The following Shortcut keys:
    • CTRL + T: display the debug toolbar.
    • CTRL + W: toggles wireframe mode when rendering triangles.
    • CTRL + B: each batch submitted to the GPU is given a unique solid color.
    • CTRL + O: display pixel overdraw using blending layers. Different colors are used for each type of triangle: green for normal, red for opacities and blue for clipping masks.
    • CTRL + P: per-primitive Antialiasing extrudes the contours of the geometry and smooths them. Useful when GPU multisampling is not enabled.
    • CTRL + F: display a performance stats panel.

Creating Applications

Once you get familiar with our samples you are ready to start creating your own applications. For that purpose we highly recommend reading the following documents:

© 2017 Noesis Technologies