Renderer - MovingBlocks/Terasology Wiki

Original URL: https://github.com/MovingBlocks/Terasology/wiki/Renderer

Introduction

At this stage this page is mostly a placeholder for renderer-related documentation that will be written.

The renderer has undergone major refactoring over the 2015-2017 period, and is now approaching the stage where A) we can map its components and what it does (see diagrams below for a starter) and B) we will be able to provide an API for modules developers to use, to improve, expand or replace the current renderer functionality.

We expect to write documentation on these matters as soon as we have sufficiently stabilized the API and its underlying code.

Early Diagrams

These diagrams are the very first to have been created since the renderer was structured enough for us to map it. They provide an early understanding of the current state of the renderer.

Debugging Rendering with RenderDoc

For easier debugging of rendering issues, you can use RenderDoc. Please refer to RenderDoc's Quick Start Documentation for the basic setup.

The recommended configuration for launching an application to capture a frame is the following:

RenderDoc Configuration

When running Terasology from IntelliJ, this should display the java command used by IntelliJ to start Terasology. This command can be used in RenderDoc to attach to the running application.