Developer Guide

Context

The context creation is the entry point of each application, since the appropriate graphics-context must be created depending on which GPU-API is used (OpenGL and/or Vulkan). OpenGL and Vulkan contexts are implemented by the classes GLContext and VkContext, respectively.

GLContext and VkContext are derived from the class BaseContext. A context is created with the create() method which is overwritten by GLContext and VkContext and defined in BaseContext.

Config

The config file oe-config.properties must be located in the resources folder. Settings like window width/height, resolution and some other parameters are configured in this file.

Below is listed a sample configuration file and a table of the parameter description:

display.title = OE Vulkan oreonworlds

display.width = 1280
display.height = 720
screen.resolution.x = 1280
screen.resolution.y = 720
sightRange = 0.8

multisamples = 8
fxaa.enable = 1

bloom.enable = 1
ssao.enable = 0
motionBlur.enable = 0
lightScattering.enable = 0
depthOfFieldBlur.enable = 0
lensFlare.enable = 0

validation.enable = 1

Parameter	Description
display.title	window header title
display.width	window width
display.height	window height
screen.resolution.x	horizontal resolution
screen.resolution.y	vertical resolution
sightRange	3D camera sight range
multisamples	number of multisamples
fxaa.enable	FXAA enable/disable
bloom.enable	Bloom enable/disable
ssao.enable	SSAO enable/disable
motionBlur.enable	Motion Blur enable/disable
lightScattering.enable	Light Scattering Blur enable/disable
depthOfFieldBlur.enable	Depth of Blur enable/disable
lensFlare.enable	Lens Flare enable/disable
validation	Vulkan Validation Layer enable/disable (only used by Vulkan contexts)