Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 1.97 KB

README.md

File metadata and controls

46 lines (36 loc) · 1.97 KB
Raw

Ox3d

Graphics engine powered by Vulkan® and C++.

Compatibility

The graphics engine offers full Vulkan support on all modern versions of Windows, excluding versions released before Windows 7 (6.1.7601). When it comes to the macOS version of the engine there is at the time writing no native Vulkan support from Apple, since Apple expects the Metal graphics API to be used instead.

However, the Vulkan SDK provides partial Vulkan support through the use of the MoltenVK library which is a "translation" or "porting" library that maps most of the Vulkan functionality to the underlying graphics support (via Metal) on macOS, iOS, and tvOS platforms. It is not a fully-conforming Vulkan driver for macOS, iOS, or tvOS devices but it works as a preliminary solution until the Metal API has been integrated in the engine.

Build Instructions

Prerequisites

Building for Windows

In order to build one can use the included build-script winBuild.bat, or by building it manually with the following shell commands:

mkdir build
cd build
cmake ..
make

This will generate an executable file named ox3d.exe which can then be ran using ./ox3d.exe.

Building for macOS

Installing CMake can either be done manually by following the link above, or by using a package manager such as Homebrew.

brew install cmake

The project can then be built by using the included build-script unixBuild.sh, or by building it manually with the following shell commands:

mkdir build
cd build
cmake ..
make

This will generate an executable file named ox3d which can then be ran using ./ox3d.