Skip to content

The Code Explained

Jump to bottom
ivanorsolic edited this page May 12, 2018 · 12 revisions

The Code Explained

When I was writing my code, only God and me knew what I was writing

a couple of months later

Now only God knows

Well, sure wouldn't like that to happen to me. :)

What can you find here

I will provide documentation for the code here. I'm currently making this project only for myself and my brother, so this documentation and wiki pages are meant for us. I do not know if I will share this with anyone else, but just in case I do so, I'd like to have it all neat and well documented, so here goes.

##The folder structure This would be the folder structure for now. As I work I will make sure to keep it updated

└───OriEngine
    ├───bin
    │   ├───engineTester
    │   └───renderEngine
    ├───lib
    │   ├───jars
    │   └───natives
    └───src
        ├───engineTester
        └───renderEngine

List of packages

Package name Description
engineTester Contains the testing classes for the render engine
renderEngine Contains the DisplayManager, Loader, Renderer and RawModel classes

List of Classes

Class name Package Description
MainGameLoop Engine tester Just a class that tests the engine.
DisplayManager Render engine Creates and controls the native window on which all graphics content is rendered.
Loader Render engine A class that loads the 3D models into memory, and it does it by storing positional data about the models into VAOs.
RawModel Render engine Represents a 3D model stored in memory.
Renderer Render engine Renders the 3D model from a VAO.

Clone this wiki locally