Skip to content

Latest commit

 

History

History
executable file
·
151 lines (141 loc) · 7.14 KB

DEV.md

File metadata and controls

executable file
·
151 lines (141 loc) · 7.14 KB
Raw

Environment setup

Linux

  • Install required libraries: 
    wget -qO- https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo tee /etc/apt/trusted.gpg.d/lunarg.asc
sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-noble.list http://packages.lunarg.com/vulkan/lunarg-vulkan-noble.list
sudo apt install vulkan-tools libvulkan-dev vulkan-validationlayers-dev spirv-tools vulkan-sdk
sudo apt install qtbase5-dev libopenal-dev libogg-dev libvorbis-dev libfreetype6-dev libcppunit-dev libssl-dev libnghttp2-dev libbrotli-dev

Windows

  • Install Msys2 application and libraries:
    • Install with default values: https://www.msys2.org/
    • Add in PATH variable: "C:\msys64\mingw64\bin"
    • In mingw64.exe (not msys2.exe): Pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-toolchain mingw64/mingw-w64-x86_64-gcc mingw-w64-x86_64-libvorbis mingw-w64-x86_64-libogg make
  • Install Freetype library:
  • Install OpenAL library:
  • Install Vulkan library:
    • Install Vulkan SDK in default folder (C:\VulkanSDK): https://vulkan.lunarg.com/sdk/home#windows
    • Copy lib & include respectively in "C:\msys64\mingw64\lib" and in "C:\msys64\mingw64\x86_64-w64-mingw32\include"
    • Create link to binaries in Mingw64 (adapt path): ln -s ${HOMEDRIVE}/VulkanSDK/1.3.296.0/Bin /home/greg/vulkan-bin
    • Update ~/.bash_profile to add binaries in Mingw64 PATH: PATH="${PATH}:/home/greg/vulkan-bin"
    • Info: vuklan-1.dll can be found in the runtime zip: https://vulkan.lunarg.com/sdk/home#windows
    • Info: Do not uninstall Vulkan SDK application because it is required for validation layer & during release process to compile shaders
  • Install curl library (custom static library only for HTTP/HTTPS protocols): 
    Pacman -S unzip openssl-devel
rm /tmp/curl/ -rf && mkdir -p /tmp/curl/ && cd /tmp/curl/
wget -P /tmp/curl/ https://curl.haxx.se/download/curl-8.11.0.zip
unzip curl-8.11.0.zip && cd /tmp/curl/curl-8.11.0
./configure CPPFLAGS=-DNGHTTP2_STATICLIB --disable-shared --enable-static --prefix=/usr/local --disable-ldap --disable-sspi --disable-ftp --disable-file --disable-dict --disable-telnet --disable-tftp --disable-hsts --disable-alt-svc --disable-rtsp --disable-pop3 --disable-imap --disable-smtp --disable-gopher --disable-smb --without-librtmp --without-libidn2 --without-libpsl --with-ssl --with-nghttp2
make V=1
make install #create library in /usr/local/lib/libcurl.a
mv /mingw64/lib/libcurl.a /mingw64/lib/libcurl.a_backup #In case libcurl is installed via package "mingw-w64-x86_64-cmake"
cp /usr/local/lib/libcurl.a /mingw64/lib/
cp -r /usr/local/include/curl/ /mingw64/x86_64-w64-mingw32/include/
cat /usr/local/lib/pkgconfig/libcurl.pc | grep "Libs.private" #Display required dependencies
  • Configure Clion:
    • In File > Settings... > Build, Execution, Deployment > Toolchains, Environment: C:\msys64\mingw64

CLion configuration

Build configuration

  • Add CMake profiles (File > Settings > Build,Execution,Deployment > CMake)
    • Profile Debug:
      • Name: Debug
      • Build type: Debug
      • Build directory: .build/debug
      • Build options: -j 14
    • Profile Release:
      • Name: RelWithDebInfo
      • Build type: RelWithDebInfo
      • Build directory: .build/release
      • Build options: -j 14
  • Add CMake applications
    • Application testExecutor (monkey):
      • Target/executable: testExecutor
      • Program arguments: unit integration monkey
    • Application testExecutor:
      • Target/executable: testExecutor
      • Program arguments: unit integration
    • Application urchinMapEditor:
      • Target/executable: urchinMapEditor

Clang analyzer configuration

  • In File > Settings > Languages & Frameworks > C/C++ > Clangd > Clang Errors and Warnings: -Wno-unused-variable,-Wno-infinite-recursion,-Werror=implicit-function-declaration,-Wno-shadow-field-in-constructor-modified,-Wno-shadow-ivar,-Wuninitialized,-Wunused-label,-Wunused-lambda-capture,-Wno-shadow

Development tips

Error handling

  • Use exception (throw std::runtime_error(...)) for methods which could be wrongly used by the final user
  • Use UserAuthorityException for errors where user has authority to fix the problem
  • Use assert (assert(...)) for methods which could be wrongly used by the engine developer
    • Note: surround assert with #ifdef URCHIN_DEBUG/#endif when condition has bad performance
  • Use logger (Logger::instance()->logError(...)) when the result of an algorithm is not the one excepted
    • Note: surround logger call with if (DebugCheck::additionalChecksEnable()) {/} when condition has bad performance

Check when "new" operator is called

  • Use following source code and add a debug point: 
    void* operator new(std::size_t sz) {
    return std::malloc(sz);
}

void* operator new[](std::size_t sz) {
    return std::malloc(sz);
}

Profiling

CPU profiler: Flame Graph

  • Install: 
    sudo apt install linux-tools-generic
cd ~/various/tools/ && git clone https://github.com/brendangregg/FlameGraph.git
  • Launch application in debug mode
  • Record (replace 'myAppName'): 
    sudo perf record -F 5000 --strict-freq -p $(pidof myAppName) -g -- sleep 25
  • Convert in SVG: 
    sudo perf script > out.perf
~/various/tools/FlameGraph/stackcollapse-perf.pl out.perf > out.folded
~/various/tools/FlameGraph/flamegraph.pl out.folded > app.svg

GPU profiler: Nsight

  • Install:
  • Launch Nsight (as root ? Nsight not working on Ubuntu 21.10): 
    ~/various/tools/nsight/host/linux-desktop-nomad-x64/ngfx-ui

Memory profiler: Valgrind - massif

  • Install: 
    sudo apt install valgrind massif-visualizer
  • Launch Valgrind with massif tool (replace 'myAppName --dev'): 
    /usr/bin/valgrind --tool=massif ./myAppName --dev
  • Execute Massif visualizer and select file produced by Valgrind 
    massif-visualizer

Memo

Coordinates used

  • 3D (e.g.: 3D models, physics rigid bodies, 3D nav mesh):
    • X+ (left), X- (right)
    • Y+ (top), Y- (bottom)
    • Z+ (near), Z- (far)
  • NDC / Vulkan:
    • X = -1 (left), X = 1 (right)
    • Y = -1 (top), Y = 1 (bottom)
  • 2D top view (e.g.: 2D nav mesh):
    • X+ (left), X- (right)
    • Y+ (far), Y- (near)