Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::ComponentApplication::StartupParameters Struct Reference

The component application settings. More...

Public Member Functions

 StartupParameters ()
 A constructor. More...
 

Public Attributes

IAllocatorAllocate * m_allocator
 If set, this allocator is used to allocate the temporary bootstrap memory and the main AZ::SystemAllocator heap. More...
 
CreateStaticModulesCallback m_createStaticModulesCallback
 Callback to create an AZ::Module for each static library that this application links to. More...
 
const char * m_appRootOverride
 If set, the application uses this root folder instead of calculating it. More...
 
bool m_loadDynamicModules
 Specifies whether to load dynamic modules described by AZ::ComponentApplication::Descriptor::m_modules. More...
 

Detailed Description

The component application settings.

Unlike AZ::ComponentApplication::Descriptor, these values must be set in code and cannot be loaded from a file.

Constructor & Destructor Documentation

◆ StartupParameters()

AZ::ComponentApplication::StartupParameters::StartupParameters ( )
inline

A constructor.

Member Data Documentation

◆ m_allocator

IAllocatorAllocate* AZ::ComponentApplication::StartupParameters::m_allocator

If set, this allocator is used to allocate the temporary bootstrap memory and the main AZ::SystemAllocator heap.

If it's nullptr, AZ::OSAllocator is used.

Default: nullptr.

◆ m_appRootOverride

const char* AZ::ComponentApplication::StartupParameters::m_appRootOverride

If set, the application uses this root folder instead of calculating it.

Default: nullptr.

◆ m_createStaticModulesCallback

CreateStaticModulesCallback AZ::ComponentApplication::StartupParameters::m_createStaticModulesCallback

Callback to create an AZ::Module for each static library that this application links to.

If your application uses no static modules, leave this setting at nullptr. You can specify dynamic modules using AZ::ComponentApplication::Descriptor::m_modules.

Default: nullptr.

◆ m_loadDynamicModules

bool AZ::ComponentApplication::StartupParameters::m_loadDynamicModules

Specifies whether to load dynamic modules described by AZ::ComponentApplication::Descriptor::m_modules.

Default: true.


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