BramTeurlings / 3DGameBridge

Wrapper Project for easy implementation of function in any 3D Game Bridge project
GNU General Public License v3.0
3 stars 1 forks source link

3DGameBridgeWrapper

This project, initially started as a passion project, has spun-off from Leia Inc and is now standalone. Thanks again to Leia Inc and former Dimenco for their support, we still strive to get SR in the hands of as many people as possible out of love for the technology.

This repo contains our wrapper for commom SR SDK functions required for weaving a stereoscopic image. On top of this, some extra helper functions were added for handling the following cases:

The class diagram of the wrapper project can be seen below: SR Game Bridge Wrapper drawio

Build instructions:

  1. Install the SR SDK from Dimenco's website (you will need to make an account): https://www.srappstore.com/develop/sdk/sr
  2. Download CMAKE
  3. Download Visual studio 2019 or up and install the C++ compiler
  4. Download googletest from the official repository and copy googletest-{version} into "unit_test/lib/"
  5. Open a terminal (like git bash)
  6. git submodule sync --recursive
  7. git submodule update --init --recursive
  8. "cmake . -B build"

You should now be able to load the generated project inside the created folder named "build".

Additional information

If you want to get an understanding of the underlying SR SDK, you can view the documentation and samples at the link below: https://developer.srappstore.com/

For any questions or contributions you may have, please refer to our Discord server.

Related Projects

3D Game Bridge Projects: https://github.com/JoeyAnthony/3DGameBridgeProjects

3D Game Bridge GUI/API: https://github.com/BramTeurlings/3DGameBridgeGUI

Code conventions

Include statements

Include statements should be ordered in the following way:

Include guards

Every header file should be using #pragma once at the top of the file before any include statements.