1.7.2.9
Gameface
cohtml::LibraryParamsWithExternalRenderingLibrary Struct Reference

Initialization parameters of the Cohtml library. More...

+ Inheritance diagram for cohtml::LibraryParamsWithExternalRenderingLibrary:

Public Member Functions

 LibraryParamsWithExternalRenderingLibrary ()
 

Public Attributes

IAllocatorAllocator
 Memory allocator for all operations of the library. Must not be null. More...
 
Logging::Severity LoggingSeverity
 The Severity of the logging messages to show. Keep this to Info or more in Shipping builds. Excessive logging can hurt performance. More...
 
Logging::ILogHandler * LogHandler
 Handler provided by the application that will receive all logging messages. If null, the default log handler will be used that prints in a local file. More...
 
const char * WritableDirectory
 Path to a writable directory. This is optional if you provide your own log handler. More...
 
bool UseDedicatedLayoutThread
 Tells if the application will spawn a dedicated layout thread or the Layout will happen in the View::Advance method Doing Layout on a separate thread is recommended as it improves scalability and reduces time spent in the Main DOM thread. For more information please refer to the Documentation. More...
 
unsigned ResourceThreadsCountHint
 Tells the runtime how man threads will be used during the Library lifetime for Resource work. The parameter is important for work balancing and especially for video playback. The video decoder will try to use as many threads (generating tasks) as there are hinted in this variable. Hinting MORE threads than the actual number that will be used will lead to undefined behaviour and most likely deadlocks in the video decoder. If uncertain about how many threads will execute Resource tasks, please set this to 1 - the default. More...
 
const char * SharedLibraryLocation
 Sets where to look for the other shared libraries that CoHTML depends on Currently only usable on PS4. If set to nullptr, the working directory will be searched for module dependencies. More...
 
OnWorkAvailableFunc OnWorkAvailable
 The Task System will notify through this callback when work is available. The tasks must be executed on a different thread. More...
 
void * OnWorkAvailableUserData
 This pointer will be passed to the OnWorkAvailable callback and can be used to hold any data the user needs to give context to the function. More...
 
PlatformSpecificParams PlatformParams
 Platform-specific parameters. More...
 
const char * DefaultStyleFontFamily
 Sets the default font family that will be used by all Elements in the Views. The default font style is analogous to setting the CSS property "font-family" of all elements to the value of this field. More...
 

Detailed Description

Initialization parameters of the Cohtml library.

Constructor & Destructor Documentation

◆ LibraryParamsWithExternalRenderingLibrary()

cohtml::LibraryParamsWithExternalRenderingLibrary::LibraryParamsWithExternalRenderingLibrary ( )
inline

Member Data Documentation

◆ Allocator

IAllocator* cohtml::LibraryParamsWithExternalRenderingLibrary::Allocator

Memory allocator for all operations of the library. Must not be null.

◆ DefaultStyleFontFamily

const char* cohtml::LibraryParamsWithExternalRenderingLibrary::DefaultStyleFontFamily

Sets the default font family that will be used by all Elements in the Views. The default font style is analogous to setting the CSS property "font-family" of all elements to the value of this field.

◆ LoggingSeverity

Logging::Severity cohtml::LibraryParamsWithExternalRenderingLibrary::LoggingSeverity

The Severity of the logging messages to show. Keep this to Info or more in Shipping builds. Excessive logging can hurt performance.

◆ LogHandler

Logging::ILogHandler* cohtml::LibraryParamsWithExternalRenderingLibrary::LogHandler

Handler provided by the application that will receive all logging messages. If null, the default log handler will be used that prints in a local file.

◆ OnWorkAvailable

OnWorkAvailableFunc cohtml::LibraryParamsWithExternalRenderingLibrary::OnWorkAvailable

The Task System will notify through this callback when work is available. The tasks must be executed on a different thread.

◆ OnWorkAvailableUserData

void* cohtml::LibraryParamsWithExternalRenderingLibrary::OnWorkAvailableUserData

This pointer will be passed to the OnWorkAvailable callback and can be used to hold any data the user needs to give context to the function.

◆ PlatformParams

PlatformSpecificParams cohtml::LibraryParamsWithExternalRenderingLibrary::PlatformParams

Platform-specific parameters.

◆ ResourceThreadsCountHint

unsigned cohtml::LibraryParamsWithExternalRenderingLibrary::ResourceThreadsCountHint

Tells the runtime how man threads will be used during the Library lifetime for Resource work. The parameter is important for work balancing and especially for video playback. The video decoder will try to use as many threads (generating tasks) as there are hinted in this variable. Hinting MORE threads than the actual number that will be used will lead to undefined behaviour and most likely deadlocks in the video decoder. If uncertain about how many threads will execute Resource tasks, please set this to 1 - the default.

◆ SharedLibraryLocation

const char* cohtml::LibraryParamsWithExternalRenderingLibrary::SharedLibraryLocation

Sets where to look for the other shared libraries that CoHTML depends on Currently only usable on PS4. If set to nullptr, the working directory will be searched for module dependencies.

Warning
Must end with a trailing slash.

◆ UseDedicatedLayoutThread

bool cohtml::LibraryParamsWithExternalRenderingLibrary::UseDedicatedLayoutThread

Tells if the application will spawn a dedicated layout thread or the Layout will happen in the View::Advance method Doing Layout on a separate thread is recommended as it improves scalability and reduces time spent in the Main DOM thread. For more information please refer to the Documentation.

◆ WritableDirectory

const char* cohtml::LibraryParamsWithExternalRenderingLibrary::WritableDirectory

Path to a writable directory. This is optional if you provide your own log handler.