Tamashii Beginner Tutorial

1 minute read

Published:

Tamashii is an excellent scientific rendering framework under development by the Department of Computer Graphics, TU Wien. Its main goal is to simplify the creation of research applications in the field of computer graphics by providing a fundamental structure in the form of libraries implementing resource loading, input handling, user interface creation, a complete rendering framework, and graphics API abstraction. The backend graphics API is Vulkan. However, Tamashii only supports single display systems, and \textbf{has not been modified for VR.}

Prerequisite

  • CMake 3.14.0 or the latest
  • Vulkan SDK 1.2.162.0 or the latest. I have also installed the VulkanRT-1.2.162.0-Installer.exe. The files under C:\Windows\SysWOW64.
  • graphics driver 450.0 or the latest
  • Operating system x64 (for Windows)

Clone the Tamashii Engine

  • git clone --recursive https://gitlab.cg.tuwien.ac.at/llipp/tamashii.git

3. Configuration Windows PowerShell (add to the Environment Variable)

  • C:\Program Files\CMake\bin
  • C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin
  • C:\vcpkg

4. vcpkg

  • git clone https://github.com/microsoft/vcpkg.git
  • Open PowerShell, and track the vcpkg folder
  • run .\bootstrap-vcpkg.bat, it will create the vcpkg.exe
  • vcpkg install (for Tamashii) tinygltf:x64-windows nlohmann-json:x64-windows imgui[win32-binding]:x64-windows stb:x64-windows glm:x64-windows spdlog:x64-windows happly:x64-windows Imguizmo:x64-windows tinyobjloader:x64-windows
  • vcpkg integrate install
  • Additionally, vcpkg might need to add in the Environment Variable, Environment Variable >> System Variable >> Path (C:/vcpkg)

5. Linking

  1. run make.bat (it will create the CMakeLists.txt)
  2. if Environmental Variable Path is provided, then no need the next step (!).
  3. modify set(CMAKE_TOOLCHAIN_FILE "C:/vcpkg/scripts/buildsystems/vcpkg.cmake" to the CMakeLists.txt (!)
  4. in tamashii folder, type the command in powershell cmake -H. -B_project -G "Visual Studio 16 2019" -A "x64" -DCMAKE_TOOLCHAIN_FILE=/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake

6. Additional Include directory (properties»C/C++»General)

  • C:\VulkanSDK\1.2.162.0\Include
  • C:\tamashii\include (for tamashii engine, and renderer)

7. Hello World

  • open the solution (.sln) file (in my case it is under _project)
  • add » new project
  • set as startup project
  • the sample program is given below:

s1 s2

8. Trash: Previously Tried (after point 5.3, Linking section)

  1. open CMakeGUI, configure (however, it has created error for me in C:\tamashii\src\rvk\CMakeLists.txt)
  2. I have manually provide the locations (Not a robust solution)

image