Skip to content
This repository has been archived by the owner on Nov 12, 2023. It is now read-only.

[E] The Build Def file

Madman10K edited this page Aug 10, 2023 · 4 revisions

The BuildDef.hpp file is an automatically generated file mostly used in generating production copies of your project. There are currently only 2 possible definitions available to define in the BuildDef.hpp file.

PRODUCTION

The PRODUCTION macro specifies if the project is compiled for production. In normal use, this macro should be explicitly undefined like this:

#undef PRODUCTION

but when generating a production build, the file briefly changes to define it

When this macro is defined, many developer related components such as the Editor will be excluded from compilation for 2 reasons

  • To lower compile time
  • To remove some specific security vulnerabilities in many parts of the editor widgets

DEVELOPMENT

The DEVELOPMENT macro will activate the developer mode that should only be used by engine developers. Normally it isn't defined but if you define it yourself you will compile with the debug code allowing you to access:

  • The Vulkan validation layers
  • Debug entities and actors
  • Debug stats
Clone this wiki locally