Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::ComponentApplication::Descriptor Struct Reference

#include <ComponentApplication.h>

Public Member Functions

 AZ_TYPE_INFO (ComponentApplication::Descriptor, "{70277A3E-2AF5-4309-9BBF-6161AFBDE792}")
 
 AZ_CLASS_ALLOCATOR (ComponentApplication::Descriptor, SystemAllocator)
 

Static Public Member Functions

static void Reflect (ReflectContext *context, ComponentApplication *app)
 Reflect the descriptor data.
 

Public Attributes

bool m_useExistingAllocator
 True if the user is creating the system allocation and setup tracking modes, if this is true all other parameters are IGNORED. (default: false)
 
bool m_allocationRecordsSaveNames
 True if we want to allocate space for saving the name/filename of each allocation so unloaded module memory leaks have valid names to read, otherwise false. (default: false, automatically true with recording mode FULL)
 
bool m_allocationRecordsAttemptDecodeImmediately
 True if we want to attempt decoding frames at time of allocation, otherwise false. Very expensive, used specifically for debugging allocations that fail to decode. (default: false)
 
bool m_autoIntegrityCheck
 True to check the heap integrity on each allocation/deallocation. (default: false)
 
bool m_markUnallocatedMemory
 True to mark all memory with 0xcd when it's freed. (default: true)
 
bool m_doNotUsePools
 True of we want to pipe all allocation to a generic allocator (not pools), this can help debugging a memory stomp. (default: false)
 
bool m_enableScriptReflection
 True if we want to enable reflection to the script context.
 
AZ::u64 m_memoryBlocksByteSize
 Memory block size in bytes.
 
Debug::AllocationRecords::Mode m_recordingMode
 When to record stack traces (default: AZ::Debug::AllocationRecords::RECORD_STACK_IF_NO_FILE_LINE)
 
ModuleDescriptorList m_modules
 

Detailed Description

Configures the component application.

Note
This structure may be loaded from a file on disk. Values that must be set by a running application should go into StartupParameters.
It's important this structure not contain members that allocate from the system allocator. Use the OSAllocator only.

Member Data Documentation

◆ m_modules

ModuleDescriptorList AZ::ComponentApplication::Descriptor::m_modules

Dynamic modules used by the application. These will be loaded on startup.


The documentation for this struct was generated from the following file: