# Blackhole

**Repository Path**: wslyx/Blackhole

## Basic Information

- **Project Name**: Blackhole
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-01-30
- **Last Updated**: 2022-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Real-time Black Hole Rendering in OpenGL

_(WIP: refactoring, cleaning up and documenting the code)_

![Screenshot](docs/screenshot.jpg)

## Prerequisite

- cmake
- I used [vcpkg](https://github.com/microsoft/vcpkg) to install the following necessary C++ libraries for this project:
  - glew
  - glfw3
  - glm
  - imgui
  - stb

### For windows setup only

- Install `cmake-3.18.3-win64-x64.msi` from this page https://cmake.org/download/
- Install vcpkg:
  - Clone vcpkg repo: `git clone https://github.com/Microsoft/vcpkg.git`
  - Enter vcpkg folder: `cd vcpkg`
  - Build vcpkg: `bootstrap-vcpkg && vcpkg integrate install`
- Install required C++ libs from vcpkg (I've only tested x64 build):
  ```
  vcpkg install glew:x64-windows glfw3:x64-windows glm:x64-windows imgui:x64-windows stb:x64-windows
  ```

## Build the code

```bash
# Configure the project and generate a native build system. Please replace <vcpkg_dir> with the actual path to your vcpkg folder.
cmake -DCMAKE_TOOLCHAIN_FILE=<vcpkg_dir>/scripts/buildsystems/vcpkg.cmake -S . -B build

# Compile / build the project
cmake --build build
```

## Acknowledgements