Formatting

Author: Kaweees

.editorconfig

@@ -14,9 +14,11 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-indent_style = space
 indent_size = 3
 
+[*.nix]
+indent_size = 2
+
 [*.py]
-indent_style = space
-indent_size = 4
+indent_size = 4
+max_line_length = 120

.gitignore

@@ -1,74 +1,50 @@
-# Prerequisites
-*.d
-
-# Object files
-*.o
-*.ko
-*.obj
-*.elf
-
-# Linker output
-*.ilk
-*.map
-*.exp
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Libraries
-*.lib
-*.a
-*.la
-*.lo
-
-# Shared objects (inc. Windows DLLs)
-*.dll
-*.so
-*.so.*
-*.dylib
-
-# Executables
-*.exe
-*.out
-*.app
-*.i*86
-*.x86_64
-*.hex
-
-# Debug files
-*.dSYM/
-*.su
-*.idb
-*.pdb
-
-# Kernel Module Compile Results
-*.mod*
-*.cmd
-.tmp_versions/
-modules.order
-Module.symvers
-Mkfile.old
-dkms.conf
-
-# CMake files
-CMakeCache.txt
-cmake_install.cmake
-CPackConfig.cmake
-_deps/
-Makefile
-obj/
-CMakeFiles/
-CPackSourceConfig.cmake
-CMakeSettings.json
-CTestTestfile.cmake
-*_include.cmake
-*_tests.cmake
-
-# Build files
-.cache/
-target/
-build/
-/.emscripten_cache
-
-!public/
+*
+
+!.github/
+!assets/
+!assets/**/
+!.editorconfig
+!.gitattributes
+!.gitignore
+!.gitmodules
+!.justfile
+!CMakeLists.txt
+!.clang-format
+!.cmake-format.py
+!LICENSE
+!README.md
+
+!docs/
+!docs/**/
+!examples/
+!examples/**/
+!include/
+!include/**/
+!scripts/
+!scripts/**/
+!tests/
+!tests/**/
+
+!*.md
+!*.svg
+!*.png
+!*.nix
+!*.lock
+!*.sh
+!*.c
+!*.h
+!*.cc
+!*.hh
+!*.cxx
+!*.hxx
+!*.cpp
+!*.hpp
+!*.cu
+!*.cuh
+
+!public/
+!public/**/
+!*.mesh
+!*.data
+!*.js
+!*.wasm

.justfile

@@ -26,7 +26,7 @@ run *package='bunny':
 build *build_type='Release':
   @mkdir -p build
   @echo "Configuring the build system..."
-  @cd build && cmake -S .. -B . -DCMAKE_BUILD_TYPE={{build_type}}
+  @cd build && cmake -S .. -B . -DCMAKE_BUILD_TYPE={{build_type}} -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
   @echo "Building the project..."
   @cd build && cmake --build . -j{{CORES}}
 
@@ -53,10 +53,9 @@ clean:
   @rm -rf target
   @if [ -n "${EM_CACHE-}" ]; then rm -rf "$EM_CACHE"; fi
 
-# Run code quality tools
 check:
   @echo "Running code quality tools..."
-  @cppcheck --enable=all --suppress=missingInclude --suppress=unusedFunction --error-exitcode=1 include/kiwigl
+  @cppcheck --error-exitcode=1 --project=build/compile_commands.json -i build/_deps/
 
 # Run code quality tools
 test:
@@ -68,7 +67,8 @@ format:
   @echo "Formatting..."
   @chmod +x ./scripts/format.sh
   @./scripts/format.sh format
-  @cmake-format -i CMakeLists.txt
+  @cmake-format -i $(find . -name "CMakeLists.txt")
+  @find . -name "*.nix" -type f -exec nixfmt {} \;
 
 # Generate documentation
 docs:

CMakeLists.txt

@@ -87,7 +87,8 @@ else()
       FetchContent_MakeAvailable(metal-cpp)
 
       # Add metal-cpp include directories
-      target_include_directories(${PROJECT_NAME} INTERFACE ${metal-cpp_SOURCE_DIR})
+      target_include_directories(${PROJECT_NAME}
+                                 INTERFACE ${metal-cpp_SOURCE_DIR})
 
       target_link_libraries(
         ${PROJECT_NAME} INTERFACE "-framework Metal" "-framework Foundation"
@@ -130,7 +131,6 @@ if(BENCHMARK)
   target_compile_definitions(${PROJECT_NAME} PRIVATE BENCHMARK_MODE)
 else()
   # Fetch SDL3
-  include(FetchContent)
   FetchContent_Declare(
     SDL3
     GIT_REPOSITORY https://github.com/libsdl-org/SDL.git

examples/CMakeLists.txt

@@ -4,4 +4,4 @@ else()
   add_subdirectory(bunny)
   add_subdirectory(cube)
   add_subdirectory(f22)
-endif()
+endif()

examples/bunny/CMakeLists.txt

@@ -8,7 +8,7 @@ target_include_directories(${EXECUTABLE_NAME} PUBLIC ${PROJECT_INCLUDES})
 target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${PROJECT_NAME})
 
 # Setting our output directory
-set_target_properties(${EXECUTABLE_NAME} PROPERTIES
-  RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
-  OUTPUT_NAME ${EXECUTABLE_NAME}
-)
+set_target_properties(
+  ${EXECUTABLE_NAME}
+  PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
+             OUTPUT_NAME ${EXECUTABLE_NAME})

examples/cube/CMakeLists.txt

@@ -8,7 +8,7 @@ target_include_directories(${EXECUTABLE_NAME} PUBLIC ${PROJECT_INCLUDES})
 target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${PROJECT_NAME})
 
 # Setting our output directory
-set_target_properties(${EXECUTABLE_NAME} PROPERTIES
-  RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
-  OUTPUT_NAME ${EXECUTABLE_NAME}
-)
+set_target_properties(
+  ${EXECUTABLE_NAME}
+  PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
+             OUTPUT_NAME ${EXECUTABLE_NAME})

examples/f22/CMakeLists.txt

@@ -8,7 +8,7 @@ target_include_directories(${EXECUTABLE_NAME} PUBLIC ${PROJECT_INCLUDES})
 target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${PROJECT_NAME})
 
 # Setting our output directory
-set_target_properties(${EXECUTABLE_NAME} PROPERTIES
-  RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
-  OUTPUT_NAME ${EXECUTABLE_NAME}
-)
+set_target_properties(
+  ${EXECUTABLE_NAME}
+  PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/"
+             OUTPUT_NAME ${EXECUTABLE_NAME})

examples/web/CMakeLists.txt

@@ -9,11 +9,12 @@ target_link_libraries(${EXECUTABLE_NAME} PRIVATE ${PROJECT_NAME})
 
 set(ASSETS_DIR ${CMAKE_SOURCE_DIR}/assets)
 message(STATUS "ASSETS_DIR: ${ASSETS_DIR}")
-target_link_options(${EXECUTABLE_NAME} PRIVATE
-    "--preload-file" "${ASSETS_DIR}@/assets")
+target_link_options(${EXECUTABLE_NAME} PRIVATE "--preload-file"
+                    "${ASSETS_DIR}@/assets")
 
 # Setting our output directory
-set_target_properties(${EXECUTABLE_NAME} PROPERTIES
-  RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/target/release/web/"
-  OUTPUT_NAME ${EXECUTABLE_NAME}
-)
+set_target_properties(
+  ${EXECUTABLE_NAME}
+  PROPERTIES RUNTIME_OUTPUT_DIRECTORY
+             "${PROJECT_SOURCE_DIR}/target/release/web/" OUTPUT_NAME
+                                                         ${EXECUTABLE_NAME})

include/kiwigl/graphics/display.cuh

@@ -9,8 +9,7 @@
 #include "../geometry/vector.hpp"
 
 namespace kiwigl {
-__device__ __host__ void cudaRotate(
-    Vector3D* vertex, double roll, double pitch, double yaw) {
+__device__ __host__ void cudaRotate(Vector3D* vertex, double roll, double pitch, double yaw) {
   // Roll (rotation around X-axis)
   double cosR = cos(roll);
   double sinR = sin(roll);
@@ -36,8 +35,7 @@ __device__ __host__ void cudaRotate(
   vertex->y = y * cosY + x * sinY;
 }
 
-__device__ __host__ void cudaTranslate3D(
-    Vector3D* vertex, double x, double y, double z) {
+__device__ __host__ void cudaTranslate3D(Vector3D* vertex, double x, double y, double z) {
   vertex->x += x;
   vertex->y += y;
   vertex->z += z;
@@ -48,22 +46,19 @@ __device__ __host__ void cudaTranslate2D(Vector2D* vertex, double x, double y) {
   vertex->y += y;
 }
 
-__device__ __host__ void cudaScale(
-    Vector3D* vertex, double x, double y, double z) {
+__device__ __host__ void cudaScale(Vector3D* vertex, double x, double y, double z) {
   vertex->x *= x;
   vertex->y *= y;
   vertex->z *= z;
 }
 
-__device__ __host__ void cudaProject(
-    const Vector3D* vertex, Vector2D* projectedVertex) {
+__device__ __host__ void cudaProject(const Vector3D* vertex, Vector2D* projectedVertex) {
   projectedVertex->x = (vertex->x * FOV) / vertex->z;
   projectedVertex->y = (vertex->y * FOV) / vertex->z;
 }
 
-__global__ void transformVerticesKernel(Face* faces, Vector3D* vertices,
-    Triangle* projectedTriangles, Vector3D rotation, Vector3D camera, int width,
-    int height, int numFaces) {
+__global__ void transformVerticesKernel(Face* faces, Vector3D* vertices, Triangle* projectedTriangles,
+                                        Vector3D rotation, Vector3D camera, int width, int height, int numFaces) {
   int idx = blockIdx.x * blockDim.x + threadIdx.x;
   if (idx >= numFaces) return;
 
@@ -92,28 +87,23 @@ __global__ void transformVerticesKernel(Face* faces, Vector3D* vertices,
 
 void Display::InitalizeCuda() {
   // Allocate memory on the device
-  cudaError_t err =
-      cudaMalloc((void**)&d_faces, mesh.faces.size() * sizeof(Face));
+  cudaError_t err = cudaMalloc((void**)&d_faces, mesh.faces.size() * sizeof(Face));
   if (err != cudaSuccess) {
-    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__,
-        __LINE__);
+    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__, __LINE__);
     exit(EXIT_FAILURE);
   }
-  err =
-      cudaMalloc((void**)&d_vertices, mesh.vertices.size() * sizeof(Vector3D));
+  err = cudaMalloc((void**)&d_vertices, mesh.vertices.size() * sizeof(Vector3D));
   if (err != cudaSuccess) {
-    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__,
-        __LINE__);
+    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__, __LINE__);
     exit(EXIT_FAILURE);
   }
-  err = cudaMalloc(
-      (void**)&d_projectedTriangles, mesh.faces.size() * sizeof(Triangle));
+  err = cudaMalloc((void**)&d_projectedTriangles, mesh.faces.size() * sizeof(Triangle));
   if (err != cudaSuccess) {
-    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__,
-        __LINE__);
+    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(err), __FILE__, __LINE__);
     exit(EXIT_FAILURE);
   }
 }
+
 void Display::FreeCuda() {
   if (d_faces != nullptr) {
     cudaFree(d_faces);
@@ -128,34 +118,30 @@ void Display::FreeCuda() {
     d_projectedTriangles = nullptr;
   }
 }
+
 void Display::LaunchCuda(int width, int height) {
   // Copy faces to device
-  cudaMemcpy(d_faces, mesh.faces.data(), mesh.faces.size() * sizeof(Face),
-      cudaMemcpyHostToDevice);
-  cudaMemcpy(d_vertices, mesh.vertices.data(),
-      mesh.vertices.size() * sizeof(Vector3D), cudaMemcpyHostToDevice);
+  cudaMemcpy(d_faces, mesh.faces.data(), mesh.faces.size() * sizeof(Face), cudaMemcpyHostToDevice);
+  cudaMemcpy(d_vertices, mesh.vertices.data(), mesh.vertices.size() * sizeof(Vector3D), cudaMemcpyHostToDevice);
 
   // Launch kernel
   dim3 threadsPerBlock(256, 1, 1);
-  dim3 blocksPerGrid(
-      (mesh.faces.size() + threadsPerBlock.x - 1) / threadsPerBlock.x, 1, 1);
-  transformVerticesKernel<<<blocksPerGrid, threadsPerBlock>>>(d_faces,
-      d_vertices, d_projectedTriangles, rotation, camera, width, height,
-      mesh.faces.size());
+  dim3 blocksPerGrid((mesh.faces.size() + threadsPerBlock.x - 1) / threadsPerBlock.x, 1, 1);
+  transformVerticesKernel<<<blocksPerGrid, threadsPerBlock>>>(d_faces, d_vertices, d_projectedTriangles, rotation,
+                                                              camera, width, height, mesh.faces.size());
 
   // Synchronize to ensure all operations are complete
   cudaDeviceSynchronize();
 
   // Copy projected triangles back to host
-  cudaMemcpy(projectedTriangles.data(), d_projectedTriangles,
-      mesh.faces.size() * sizeof(Triangle), cudaMemcpyDeviceToHost);
+  cudaMemcpy(projectedTriangles.data(), d_projectedTriangles, mesh.faces.size() * sizeof(Triangle),
+             cudaMemcpyDeviceToHost);
 
   // Check for CUDA errors
   cudaError_t cudaStatus = cudaGetLastError();
   if (cudaStatus != cudaSuccess) {
-    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(cudaStatus),
-        __FILE__, __LINE__);
+    fprintf(stderr, "%s in %s at line %d\n", cudaGetErrorString(cudaStatus), __FILE__, __LINE__);
     exit(EXIT_FAILURE);
   }
 }
-}  // namespace kiwigl
+} // namespace kiwigl