config.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_CONFIG_H_
#define DVD_CONFIG_H_
 
#include "Platform/Headers/PlatformDataTypes.h"
 
namespace Divide {
namespace Config {
 
namespace Build {
#if defined(_DEBUG)
    constexpr bool IS_DEBUG_BUILD   = true;
 
    constexpr bool IS_PROFILE_BUILD = false;
    constexpr bool IS_RELEASE_BUILD = false;
#elif defined(_PROFILE)
    constexpr bool IS_PROFILE_BUILD = true;
 
    constexpr bool IS_DEBUG_BUILD   = false;
    constexpr bool IS_RELEASE_BUILD = false;
#else
    constexpr bool IS_RELEASE_BUILD = true;
 
    constexpr bool IS_DEBUG_BUILD   = false;
    constexpr bool IS_PROFILE_BUILD = false;
#endif
 
    // Set IS_SHIPPING_BUILD to true to disable non-required functionality for shipped games: editors, debug code, etc
    constexpr bool IS_SHIPPING_BUILD = IS_RELEASE_BUILD && false;
#if defined(_START_IN_EDITOR)
    constexpr bool IS_EDITOR_BUILD = true;
    constexpr bool ENABLE_EDITOR = true;
#else //_START_IN_EDITOR
    constexpr bool IS_EDITOR_BUILD = false;
    constexpr bool ENABLE_EDITOR = !IS_SHIPPING_BUILD;
#endif //_START_IN_EDITOR
 
} //namespace Build
 
namespace Assert {
    constexpr bool LOG_ASSERTS = !Build::IS_RELEASE_BUILD;
 
    constexpr bool SHOW_MESSAGE_BOX = LOG_ASSERTS;
 
    constexpr bool CONTINUE_ON_ASSERT = false;
} // namespace Assert
 
namespace Profile {
    constexpr unsigned short MAX_PROFILE_TIMERS = 1 << 10;
 
    constexpr bool ENABLE_FUNCTION_PROFILING = !Build::IS_SHIPPING_BUILD;
} // namespace Profile
 
 
constexpr float ALPHA_DISCARD_THRESHOLD = 1.f - 0.05f;
 
constexpr unsigned char MINIMUM_VULKAN_MINOR_VERSION = 3u;
constexpr unsigned char DESIRED_VULKAN_MINOR_VERSION = 3u;
 
constexpr U16 TARGET_FRAME_RATE = 60;
 
constexpr U8 MAX_FRAMES_IN_FLIGHT = 3u;
 
constexpr U8 TICK_DIVISOR = 2u;
 
constexpr U16 MIN_SLEEP_THRESHOLD_MS = 5u;
 
constexpr size_t REQUIRED_RAM_SIZE_IN_BYTES = 2u * (1024u * 1024 * 1024); //2Gb
 
constexpr U32 MAX_POOLED_TASKS = 1 << 16;
 
constexpr U16 MAX_BONE_COUNT_PER_NODE = 1 << 7;
 
constexpr U16 MAX_VISIBLE_NODES = 1 << 13;
 
constexpr U16 MAX_CONCURRENT_MATERIALS = 1 << 14;
 
constexpr U8 MAX_CLIP_DISTANCES = 3u;
 
constexpr U8 MAX_CULL_DISTANCES = 1u;
 
constexpr U8 MAX_REFLECTIVE_NODES_IN_VIEW = Build::IS_DEBUG_BUILD ? 3u : 5u;
 
constexpr U8 MAX_REFRACTIVE_NODES_IN_VIEW = Build::IS_DEBUG_BUILD ? 2u : 4u;
 
constexpr U8 MAX_REFLECTIVE_PROBES_PER_PASS = 6u;
 
constexpr U8 MAX_LOCAL_PLAYER_COUNT = 4u;
 
constexpr U8 MAX_DEBUG_SCOPE_DEPTH = 32u;
 
namespace Lighting {
    constexpr U8 MAX_SHADOW_CASTING_DIRECTIONAL_LIGHTS = 2u;
    constexpr U8 MAX_SHADOW_CASTING_POINT_LIGHTS = 4u;
    constexpr U8 MAX_SHADOW_CASTING_SPOT_LIGHTS = 6u;
 
    constexpr U8 MAX_SHADOW_CASTING_LIGHTS = MAX_SHADOW_CASTING_DIRECTIONAL_LIGHTS + MAX_SHADOW_CASTING_POINT_LIGHTS + MAX_SHADOW_CASTING_SPOT_LIGHTS;
 
    constexpr U8 MAX_CSM_SPLITS_PER_LIGHT = 4u;
 
    constexpr U16 MAX_ACTIVE_LIGHTS_PER_FRAME = 1 << 12;
 
    namespace ClusteredForward {
        constexpr U16 MAX_LIGHTS_PER_CLUSTER = 100u;
 
        constexpr U8 CLUSTERS_X = 16u;
        constexpr U8 CLUSTERS_Y = 8u;
        constexpr U8 CLUSTERS_Z = 24u; 
        constexpr U8 CLUSTERS_X_THREADS = CLUSTERS_X;
        constexpr U8 CLUSTERS_Y_THREADS = CLUSTERS_Y;
        constexpr U8 CLUSTERS_Z_THREADS = CLUSTERS_Z / 6u;
        constexpr U16 MAX_COMPUTE_THREADS = 1024u; //Value from some random, old D3D spec, I think ...
 
        // This may not be a hard requirement but for now it works fine
        static_assert(CLUSTERS_X_THREADS * CLUSTERS_Y_THREADS * CLUSTERS_Z_THREADS <= MAX_COMPUTE_THREADS);
    } // namespace ClusteredForward
} // namespace Lighting
 
namespace Networking {
    constexpr U16 NETWORK_SEND_FREQUENCY_HZ = 20;
 
    constexpr U16 NETWORK_SEND_RETRY_COUNT = 3;
} // namespace Networking
 
constexpr bool ENABLE_GPU_VALIDATION = !Build::IS_SHIPPING_BUILD;
 
constexpr bool ENABLE_LOCALE_FILE_WATCHER = !Build::IS_SHIPPING_BUILD && Build::ENABLE_EDITOR;
 
constexpr char DEFAULT_PROJECT_NAME[] = "Default";
constexpr char DEFAULT_SCENE_NAME[] = "Default";
constexpr char DELETED_FOLDER_NAME[] = "Deleted";
constexpr char ENGINE_NAME[] = "Divide Framework";
constexpr auto ENGINE_VERSION_MAJOR = 0u;
constexpr auto ENGINE_VERSION_MINOR = 1u;
constexpr auto ENGINE_VERSION_PATCH = 0u;
 
}  // namespace Config
}  // namespace Divide
 
constexpr char OUTPUT_LOG_FILE[] = "console.log";
constexpr char ERROR_LOG_FILE[] = "errors.log";
 
#endif  //DVD_CONFIG_H_