Settings.h File Reference

#include "Engine/Material/MaterialTypes.h"
#include <cstdint>
#include <vector>

Include dependency graph for Settings.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	LodSettings
	LOD (Level of Detail) system settings. Controls the Nanite-style per-cluster LOD selection behavior. More...

Enumerations
enum class	OPENXR_LAUNCH_MODE {   DEFAULT ,   OCULUS_LAUNCH }
enum class	GPU_DEBUGGING_MODE {   NONE ,   GPU_PRINTF ,   GPU_VALIDATION }

Variables
const std::vector< const char * >	validationLayers
constexpr int	INITIAL_WINDOW_WIDTH = 1920
constexpr int	INITIAL_WINDOW_HEIGHT = 1080
constexpr int	MAX_FRAMES_IN_FLIGHT = 2
constexpr bool	ARE_VALIDATION_LAYERS_ENABLED = false
constexpr bool	IS_VSYNC_ENABLED = false
constexpr uint32_t	MAX_TEXTURE_COUNT = 1024u
constexpr uint32_t	MAX_MESH_COUNT = 1024u
constexpr uint32_t	MAX_MESHLETS_PER_BIN = 262144u
constexpr uint32_t	MAX_PIPELINES = 32u
constexpr OPENXR_LAUNCH_MODE	DEFAULT_OPENXR_LAUNCH_MODE = OPENXR_LAUNCH_MODE::DEFAULT
	Engine execution modes (mutually exclusive)
constexpr GPU_DEBUGGING_MODE	USE_GPU_PRINTF = GPU_DEBUGGING_MODE::GPU_PRINTF
constexpr uint32_t	MESHLET_VERTEX_COUNT = 252
constexpr uint32_t	MESHLET_TRIANGLE_COUNT = 252
constexpr EngineCore::PipelineNames	DEFAULT_MATERIAL_PIPELINE = EngineCore::PipelineNames::NORMALS_SHADER

Enumeration Type Documentation

GPU_DEBUGGING_MODE

enum class GPU_DEBUGGING_MODE

strong

Enumerator
NONE
GPU_PRINTF
GPU_VALIDATION

Definition at line 12 of file Settings.h.

OPENXR_LAUNCH_MODE

enum class OPENXR_LAUNCH_MODE

strong

Enumerator
DEFAULT
OCULUS_LAUNCH

Definition at line 6 of file Settings.h.

Variable Documentation

ARE_VALIDATION_LAYERS_ENABLED

bool ARE_VALIDATION_LAYERS_ENABLED = false

constexpr

Definition at line 29 of file Settings.h.

Referenced by EngineCore::Engine::cleanup(), and EngineCore::ApplicationContext::createVulkanInstance().

DEFAULT_MATERIAL_PIPELINE

EngineCore::PipelineNames DEFAULT_MATERIAL_PIPELINE = EngineCore::PipelineNames::NORMALS_SHADER

constexpr

Definition at line 59 of file Settings.h.

Referenced by EngineCore::MaterialShader::getPipelineNameFromString(), EngineCore::RenderingDataManager::updatePrimitiveData(), EngineCore::RenderingDataManager::updatePrimitiveDataInstanced(), and EngineCore::GltfLoader::VulkanSchneeMaterialExtension::VulkanSchneeMaterialExtension().

DEFAULT_OPENXR_LAUNCH_MODE

OPENXR_LAUNCH_MODE DEFAULT_OPENXR_LAUNCH_MODE = OPENXR_LAUNCH_MODE::DEFAULT

constexpr

Engine execution modes (mutually exclusive)

• Neither defined: Full VR rendering with XR and mesh shaders
• COMPUTE_DEBUG: No XR/mesh shaders, but compute pipeline runs with readback
• HEADLESS: Nothing runs (placeholder shaders, no dispatches) - for CI/testing

Uncomment ONE of the following defines to enable that mode:

Definition at line 53 of file Settings.h.

Referenced by EngineCore::ApplicationContext::createResources(), and EngineCore::ApplicationContext::retrieveXrSystemId().

INITIAL_WINDOW_HEIGHT

int INITIAL_WINDOW_HEIGHT = 1080

constexpr

Definition at line 25 of file Settings.h.

Referenced by EngineCore::Window::Window().

INITIAL_WINDOW_WIDTH

int INITIAL_WINDOW_WIDTH = 1920

constexpr

Definition at line 24 of file Settings.h.

Referenced by EngineCore::Window::Window().

IS_VSYNC_ENABLED

bool IS_VSYNC_ENABLED = false

constexpr

Definition at line 34 of file Settings.h.

MAX_FRAMES_IN_FLIGHT

int MAX_FRAMES_IN_FLIGHT = 2

constexpr

Definition at line 26 of file Settings.h.

Referenced by EngineCore::Renderer::advanceFrameIndices(), EngineCore::Renderer::allocateDescriptors(), EngineCore::Renderer::createHiZMipDescriptorSets(), EngineCore::Renderer::createHiZSPDDescriptorSets(), EngineCore::Renderer::renderToXr(), EngineCore::Renderer::submitInitialTransfers(), and EngineCore::Renderer::syncTimelineAfterPause().

MAX_MESH_COUNT

uint32_t MAX_MESH_COUNT = 1024u

constexpr

Definition at line 36 of file Settings.h.

Referenced by EngineCore::AssetManager::AssetManager(), and EngineCore::AssetManager::AssetManager().

MAX_MESHLETS_PER_BIN

uint32_t MAX_MESHLETS_PER_BIN = 262144u

constexpr

Definition at line 37 of file Settings.h.

Referenced by EngineCore::RenderProcess::createBinnedVisibleMeshletIndexBuffer(), EngineCore::RenderProcess::createMeshletCounterBuffer(), EngineCore::RenderProcess::createMeshletToObjectMapBuffer(), EngineCore::SceneManager::createMeshletToObjectMapBuffer(), EngineCore::RenderProcess::createObjectMeshletDataBuffer(), EngineCore::Renderer::recordPass2RenderPass(), and EngineCore::Renderer::recordRenderPass().

MAX_PIPELINES

uint32_t MAX_PIPELINES = 32u

constexpr

Definition at line 39 of file Settings.h.

Referenced by EngineCore::RenderProcess::createBinnedVisibleMeshletIndexBuffer(), EngineCore::RenderProcess::createBinningAllocatorBuffers(), EngineCore::RenderProcess::createIndirectDrawBuffer(), EngineCore::RenderProcess::createMeshletCounterBuffer(), and EngineCore::Renderer::createPrepareDrawResources().

MAX_TEXTURE_COUNT

uint32_t MAX_TEXTURE_COUNT = 1024u

constexpr

Definition at line 35 of file Settings.h.

Referenced by EngineCore::LayoutBindingsBuilder::addTextureBuffer(), EngineCore::AssetManager::AssetManager(), and EngineCore::AssetManager::AssetManager().

MESHLET_TRIANGLE_COUNT

uint32_t MESHLET_TRIANGLE_COUNT = 252

constexpr

Definition at line 57 of file Settings.h.

MESHLET_VERTEX_COUNT

uint32_t MESHLET_VERTEX_COUNT = 252

constexpr

Definition at line 56 of file Settings.h.

USE_GPU_PRINTF

GPU_DEBUGGING_MODE USE_GPU_PRINTF = GPU_DEBUGGING_MODE::GPU_PRINTF

constexpr

Definition at line 54 of file Settings.h.

Referenced by EngineCore::ApplicationContext::createVulkanInstance(), and EngineCore::Engine::debugCallback().

validationLayers

const std::vector<const char*> validationLayers

Initial value:

= {
    "VK_LAYER_KHRONOS_validation",
    "VK_LAYER_KHRONOS_synchronization2"
}

Definition at line 19 of file Settings.h.

Referenced by EngineCore::Engine::checkValidationLayerSupport().