Skip to content

Commit 93dec81

Browse files
authored
Update build instructions
1 parent 474bd50 commit 93dec81

1 file changed

Lines changed: 29 additions & 30 deletions

File tree

README.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 3DGS.cpp
22

3-
3DGS.cpp is an (not-yet-) highly optimized, cross-platform implementation
3+
3DGS.cpp is a high performance, cross-platform implementation
44
of [Gaussian Splatting](https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/) using
55
the [Vulkan API](https://www.khronos.org/vulkan/) and compute pipelines.
66

@@ -19,30 +19,29 @@ with support for warp-level primitives (subgroups).
1919
* [Linux](https://github.com/shg8/3DGS.cpp/releases/download/nightly/vulkan_splatting_viewer-ubuntu-latest-amd64-nightly)
2020
* iOS, iPad OS, visionOS (as an iPad app) on [TestFlight](https://testflight.apple.com/join/0WzabeP7)
2121

22-
## Command Line Usage
22+
## Command Line Viewer
2323

2424
```
25-
./vulkan_splatting [options] <input_file.ply>
25+
./vulkan_splatting_viewer {OPTIONS} [scene]
26+
27+
Vulkan Splatting
28+
29+
OPTIONS:
30+
31+
-h, --help Display this help menu
32+
--validation Enable Vulkan validation layers
33+
-v, --verbose Enable verbose logging
34+
-d[physical-device],
35+
--device=[physical-device] Select physical device by index
36+
-i, --immediate-swapchain Set swapchain mode to immediate
37+
(VK_PRESENT_MODE_IMMEDIATE_KHR)
38+
-w[width], --width=[width] Set window width
39+
-h[height], --height=[height] Set window height
40+
--no-gui Disable GUI
41+
scene Path to scene fil
2642
```
2743

28-
### Options
29-
30-
- `--validation`: Enable Vulkan validation layers
31-
32-
- `-v`, `--verbose`: Enable verbose logging
33-
34-
- `-d`, `--device <index>`: Select GPU by index
35-
36-
- `-i`, `--immediate-swapchain`: Set swapchain mode to immediate (VK_PRESENT_MODE_IMMEDIATE_KHR)
37-
38-
- `-w`, `--width <width>`: Set window width
39-
40-
- `-h`, `--height <height>`: Set window height
41-
42-
- `--no-gui`: Disable GUI
43-
4444
## Building
45-
4645
### Linux
4746

4847
3DGS.cpp requires the following dependencies:
@@ -53,26 +52,26 @@ The easiest way to install the first three is through the [LunarG Vulkan SDK](ht
5352
Alternatively, you can install the corresponding packages from your distro. For Ubuntu, the packages to install
5453
are `vulkan-headers, vulkan-validationlayers, glslang-dev, libglfw3-dev, libglm-dev`.
5554

55+
```
56+
git clone https://github.com/shg8/3DGS.cpp/
57+
cd 3DGS.cpp
58+
mkdir build
59+
cmake -DCMAKE_BUILD_TYPE=Release -S ./ -B ./build
60+
cmake --build ./build -j4
61+
```
62+
The command line viewer will be under `build/apps/viewer/`.
5663
### Windows
5764

5865
After installing Vulkan SDK, set the `VULKAN_SDK` environmental variable to the install path. Alternatively,
5966
pass `-DVULKAN_SDK=\INSTALL\LOCATION\OF\YOUR\SDK` to CMake when configuring.
6067

61-
A full CMake configure command is as follows:
62-
63-
```
64-
mkdir .\VulkanSplatting\build
65-
cmake -DCMAKE_BUILD_TYPE=Release -DVULKAN_SDK=\INSTALL\LOCATION\OF\YOUR\SDK -S .\VulkanSplatting -B .\VulkanSplatting\build
66-
```
67-
6868
### macOS
69-
70-
After installing the Vulkan SDK, please proceed with CMake configuration and build steps as usual.
69+
After installing the [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/), please proceed with CMake configuration and build steps.
7170

7271
### iOS, iPadOS, visionOS
7372
1. Make sure that the Vulkan SDK is installed
7473
2. Run the `xcode_setup` CMake target
75-
3. Download the [prebuilt MoltenVK libraries](https://github.com/KhronosGroup/MoltenVK/actions) or build it yourself. Unzip the downloaded artifact from a MoltenVK workflow. If you're not sure which one you want to use, pick the one from the latest tag.
74+
3. Download the [prebuilt MoltenVK libraries](https://github.com/KhronosGroup/MoltenVK/actions) or build it yourself. Unzip the downloaded artifact from a MoltenVK workflow. If you're not sure which one you want to use, pick the one from the latest tag
7675
4. Place the MoltenVK folder that contains the `dynamic`, `include`, and `static` folders under `apps/apple`
7776
5. Set your development team id in `project.xcconfig`
7877
6. Profit

0 commit comments

Comments
 (0)