Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CMake build system #8

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
cmake_minimum_required(VERSION 3.10)

project(spz
DESCRIPTION "A 3D Gaussians format"
LANGUAGES C CXX
VERSION 0.1)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me know if this version number is ok. It might be useful to add a git tag v0.1 corresponding to this number at some point.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nbutko you didn't answer to this remark. Does version 0.1 ok to you?
Also, it's very important to create a release with a tag version on github so we can track updates on our side and also download source code using URL like https://github.com/nianticlabs/spz/archive/refs/tags/v0.1.tar.gz


include(GNUInstallDirs)

# zlib is required to build the project
find_package(ZLIB REQUIRED)

set(spz_sources
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/load-spz.cc"
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/splat-c-types.cc"
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/splat-types.cc"
)

set(spz_headers
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/load-spz.h"
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/splat-c-types.h"
"${CMAKE_CURRENT_SOURCE_DIR}/src/cc/splat-types.h"
)

# create the library and configure it
add_library(spz ${spz_sources})

target_link_libraries(spz PRIVATE ZLIB::ZLIB)

target_include_directories(spz
PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/cc>
INTERFACE $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
)

set_target_properties(spz PROPERTIES
PUBLIC_HEADER "${spz_headers}"
)

# Installation

## Install spzConfig.cmake spz::spz target can be found when calling find_package(spz)
include(CMakePackageConfigHelpers)
configure_package_config_file(
"${CMAKE_CURRENT_SOURCE_DIR}/cmake/spzConfig.cmake.in"
"${CMAKE_BINARY_DIR}/cmake/spzConfig.cmake"
INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/spz")
write_basic_package_version_file(
"${CMAKE_BINARY_DIR}/cmake/spzConfigVersion.cmake"
VERSION "${spz_VERSION}"
COMPATIBILITY SameMajorVersion)
install(
FILES
"${CMAKE_BINARY_DIR}/cmake/spzConfig.cmake"
"${CMAKE_BINARY_DIR}/cmake/spzConfigVersion.cmake"
DESTINATION
"${CMAKE_INSTALL_LIBDIR}/cmake/spz"
)

install(TARGETS spz
EXPORT spzTargets
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

install(EXPORT spzTargets
NAMESPACE spz::
DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/spz"
)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ with minimal visual differences between the two.

### C++

Requires `libz` as the only dependent library, otherwise the code is completely self-contained. No
build system is provided (bring your own build).
Requires `libz` as the only dependent library, otherwise the code is completely self-contained.
A CMake build system is provided for convenience.

## API

Expand Down
8 changes: 8 additions & 0 deletions cmake/spzConfig.cmake.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
@PACKAGE_INIT@

include(${CMAKE_CURRENT_LIST_DIR}/spzConfigVersion.cmake)
message(STATUS "Found spz ${PACKAGE_VERSION}")

include(${CMAKE_CURRENT_LIST_DIR}/spzTargets.cmake)

check_required_components(spz)
1 change: 1 addition & 0 deletions src/cc/splat-types.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#pragma once

#include <algorithm>
#include <array>
#include <cmath>
#include <cstring>
Expand Down