Functions
Coherent::UIGT::UISystem *COHERENT_CDECL	InitializeUIGTSystem (const char licenseKey, const Coherent::UIGT::SystemSettings &settings, Coherent::LoggingGT::Severity severity=Coherent::LoggingGT::Info, Coherent::LoggingGT::ILogHandler logHandler=nullptr, Coherent::UIGT::UISystemListener *systemListener=nullptr)
	InitializeUIGTSystem Initializes Coherent UI GT and creates the system object More...

Coherent::UIGT::UISystem *COHERENT_CDECL	InitializeUIGTSystemWithRenderingLibrary (const char licenseKey, const Coherent::UIGT::SystemSettingsWithExternalRenderingLibrary &settings, renoir::IRenderingLibrary renderingLibrary, Coherent::LoggingGT::Severity severity=Coherent::LoggingGT::Info, Coherent::LoggingGT::ILogHandler logHandler=nullptr, Coherent::UIGT::UISystemListener systemListener=nullptr)
	InitializeUIGTSystemWithRenderingLibrary Initializes Coherent UI GT and creates the system object. Uses an externally initialized rendering library More...

void COHERENT_CDECL	FreeUIGTLibraryResources ()
	FreeUIGTLibraryResources Frees all library resources remaining. This call will unload most modules used by Coherent UI GT and free all memory kept for quick initialization. Call this after the last Uninitialize call. After this the library can't be used anymore during the program run. More...

Detailed Description

Function Documentation

◆ FreeUIGTLibraryResources()

void COHERENT_CDECL FreeUIGTLibraryResources ( )

FreeUIGTLibraryResources Frees all library resources remaining. This call will unload most modules used by Coherent UI GT and free all memory kept for quick initialization. Call this after the last Uninitialize call. After this the library can't be used anymore during the program run.

Note: : Calling FreeUIGTLibraryResources is optional.

Warning: This should be called after the last Uninitialize call in the program and also SystemSettings::MemoryAllocator must be alive when FreeUIGTLibraryResources is called.

◆ InitializeUIGTSystem()

Coherent::UIGT::UISystem* COHERENT_CDECL InitializeUIGTSystem	(	const char *	licenseKey,
		const Coherent::UIGT::SystemSettings &	settings,
		Coherent::LoggingGT::Severity	severity = `Coherent::LoggingGT::Info`,
		Coherent::LoggingGT::ILogHandler *	logHandler = `nullptr`,
		Coherent::UIGT::UISystemListener *	systemListener = `nullptr`
	)

InitializeUIGTSystem Initializes Coherent UI GT and creates the system object

Parameters

licenseKey	your license key
settings	a struct describing all the parameters of the system
severity	the severity of the logging
logHandler	the ILogHandler object that will log messages
systemListener	the UISystemListener object that will receive UI system messages and callbacks

Returns: the UISystem object

Note: The UISystemListener instance, if not null, must be alive during the lifetime of the returned UISystem

Warning: This method is ALWAYS synchronous

◆ InitializeUIGTSystemWithRenderingLibrary()

Coherent::UIGT::UISystem* COHERENT_CDECL InitializeUIGTSystemWithRenderingLibrary	(	const char *	licenseKey,
		const Coherent::UIGT::SystemSettingsWithExternalRenderingLibrary &	settings,
		renoir::IRenderingLibrary *	renderingLibrary,
		Coherent::LoggingGT::Severity	severity = `Coherent::LoggingGT::Info`,
		Coherent::LoggingGT::ILogHandler *	logHandler = `nullptr`,
		Coherent::UIGT::UISystemListener *	systemListener = `nullptr`
	)

InitializeUIGTSystemWithRenderingLibrary Initializes Coherent UI GT and creates the system object. Uses an externally initialized rendering library