cohtml.Net.LibraryParamsWithExternalRenderingLibrary
Initialization parameters of the Cohtml library.
Inherits from SystemIDisposable
Inherited by cohtml.Net.LibraryParams
Public Functions
| Name | |
|---|---|
| virtual void | Dispose() |
| LibraryParamsWithExternalRenderingLibrary() |
Public Properties
| Name | |
|---|---|
| IVirtualAllocator | VirtualAllocator |
| Severity | LoggingSeverity The Severity of the logging messages to show. Keep this to Info or more in Shipping builds. Excessive logging can hurt performance. |
| LogHandler | 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. |
| PerformanceHandler | PerformanceHandler Handler provided by the application that will receive performance warning messages. |
| IFileSystemWriter | FileSystemWriter Optional file system handler that allows writing to a file on the local filesystem. The file writer is used by some features (like the profiling on some platforms) to open a file where data is written. |
| string | WritableDirectory Path to a writable directory. This is optional if you provide your own log handler. |
| 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 UI thread. For more information please refer to the Documentation. |
| bool | EnableInternalAllocator The internal memory allocator efficiently reuses already allocated memory, which enhances performance at the cost of some memory overhead. The internal memory allocator is enabled by default. By disabling the internal allocator Cohtml will free any unused memory to the client immediately, which will reduce the overall memory footprint. |
| bool | ExposeGC Enables an extension in the JS VM which exposes a global gc() function in the JS context that will try to force a full garbage collection. There is no guarantee that a GC will be performed or garbage will be collected. Garbage collection is a complicated process that is best done when it’s left to happen automatically. Use sparingly as a forced full garbage collection tends to be a heavy operation. |
| string | ScriptEngineFlags Optional flags that are going to be passed to the Scripting Engine upon initialization. Example: jitless expose_gc For V8 engine, the available options can be found here: https://chromium.googlesource.com/v8/v8/+/f212270c9952fd76a14f0b72d9f5c51a99e3af22/src/flags/flag-definitions.h. |
| uint | ResourceThreadsCountHint Tells the runtime how many 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. |
| string | 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. Must end with a trailing slash. |
| global.System.IntPtr | 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. |
| PlatformSpecificParams | PlatformParams Platform-specific parameters. |
| string | 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. |
Protected Attributes
| Name | |
|---|---|
| bool | swigCMemOwn |
Public Functions Documentation
function Dispose
virtual void Dispose()
Reimplemented by: cohtml.Net.LibraryParams.Dispose
function LibraryParamsWithExternalRenderingLibrary
LibraryParamsWithExternalRenderingLibrary()
Public Property Documentation
property VirtualAllocator
IVirtualAllocator VirtualAllocator;
property LoggingSeverity
Severity LoggingSeverity;
The Severity of the logging messages to show. Keep this to Info or more in Shipping builds. Excessive logging can hurt performance.
property LogHandler
LogHandler 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.
property PerformanceHandler
PerformanceHandler PerformanceHandler;
Handler provided by the application that will receive performance warning messages.
property FileSystemWriter
IFileSystemWriter FileSystemWriter;
Optional file system handler that allows writing to a file on the local filesystem. The file writer is used by some features (like the profiling on some platforms) to open a file where data is written.
property WritableDirectory
string WritableDirectory;
Path to a writable directory. This is optional if you provide your own log handler.
property UseDedicatedLayoutThread
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 UI thread. For more information please refer to the Documentation.
property EnableInternalAllocator
bool EnableInternalAllocator;
The internal memory allocator efficiently reuses already allocated memory, which enhances performance at the cost of some memory overhead. The internal memory allocator is enabled by default. By disabling the internal allocator Cohtml will free any unused memory to the client immediately, which will reduce the overall memory footprint.
property ExposeGC
bool ExposeGC;
Enables an extension in the JS VM which exposes a global gc() function in the JS context that will try to force a full garbage collection. There is no guarantee that a GC will be performed or garbage will be collected. Garbage collection is a complicated process that is best done when it’s left to happen automatically. Use sparingly as a forced full garbage collection tends to be a heavy operation.
property ScriptEngineFlags
string ScriptEngineFlags;
Optional flags that are going to be passed to the Scripting Engine upon initialization. Example: jitless expose_gc For V8 engine, the available options can be found here: https://chromium.googlesource.com/v8/v8/+/f212270c9952fd76a14f0b72d9f5c51a99e3af22/src/flags/flag-definitions.h.
property ResourceThreadsCountHint
uint ResourceThreadsCountHint;
Tells the runtime how many 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.
property SharedLibraryLocation
string 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. Must end with a trailing slash.
property OnWorkAvailableUserData
global.System.IntPtr 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.
property PlatformParams
PlatformSpecificParams PlatformParams;
Platform-specific parameters.
property DefaultStyleFontFamily
string 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.
Protected Attributes Documentation
variable swigCMemOwn
bool swigCMemOwn;