cohtml::LibraryParams
#include <Library.h>
Inherits from cohtml::LibraryParamsWithExternalRenderingLibrary, renoir::CommonRenderingLibraryParams
Public Functions
| Name | |
|---|---|
| LibraryParams() |
Public Attributes
| Name | |
|---|---|
| IFileSystemReader * | FileSystemReader System reader used for loading local resources. |
Additional inherited members
Public Functions inherited from cohtml::LibraryParamsWithExternalRenderingLibrary
| Name | |
|---|---|
| LibraryParamsWithExternalRenderingLibrary() |
Public Attributes inherited from cohtml::LibraryParamsWithExternalRenderingLibrary
| Name | |
|---|---|
| IAllocator * | Allocator Memory allocator for all operations of the library. If null, a default malloc allocator will be used instead. |
| IVirtualAllocator * | VirtualAllocator Virtual memory allocator used by the V8 JavaScript engine. If null, a default virtual allocator will be used. |
| Logging::LoggingSettings | LoggingFilters Configures filtering of categorized log messages. Only messages matching the enabled TargetUser and MessageType flags are passed to the log handler. Minimum severity threshold is configured via LoggingFilters.MinimumSeverity. By default all categories are enabled and severity is set to Info. Reduce enabled categories in Shipping builds to avoid excessive logging. |
| 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. |
| Profile::IPerformanceHandler * | PerformanceHandler Handler provided by the application that will receive performance warning messages. |
| IProfileMarkersTracer * | ProfileMarkersTracer Tracer object that will receive notifications when Cohtml is being profiled. |
| 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. |
| const char * | WritableDirectory Path to a writable directory. This is optional if you provide your own log handler. |
| 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. |
| 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. |
| const char * | 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. |
| unsigned | 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. |
| 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. |
| OnWorkAvailableFunc | OnWorkAvailable The Task System will notify through this callback when work is available. The tasks must be executed on a different thread. |
| 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. |
| PlatformSpecificParams | PlatformParams Platform-specific parameters. |
| 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. |
| CompatibilityFlags | CompatibilitySettings Compatibility settings that can be used to enable or disable specific legacy behaviors of the Library. |
Public Functions inherited from renoir::CommonRenderingLibraryParams
| Name | |
|---|---|
| CommonRenderingLibraryParams() |
Public Attributes inherited from renoir::CommonRenderingLibraryParams
| Name | |
|---|---|
| bool | AllowMultipleRenderingThreads Allows usage of Rendering Library calls from different threads. If not enabled, using rendering methods from different threads produces an error message. |
| bool | SetRenderingResourcesDebugNames Will set debug names on rendering resources. The actual use of these names depends on the rendering backend implementation. Use this for debugging purposes only as it incurs a slight performance penalty. |
| bool | AllowMultithreadedCommandProcessing Will enable multi thread awarenes of the library which will result in more mutex locks/unlocks. |
| float | PathTessellationThresholdRatio Sets the threshold ratio, which is used for determining whether to reuse old tessellated paths or tessellate new ones when changing the display size of paths (e.g. SVGs). If the threshold ratio is lower, then more paths will be tessellated, which will lead to a higher path visual quality, but also to increased memory usage. On the other hand, setting the threshold ratio to a higher value will result in reuse of more tessellated paths, which may cause lower path visual quality, because old tessellated paths are upscaled or downscaled in order to be reused. However, higher threshold value will lead to a decrease in the memory usage. |
| unsigned | TextAtlasWidth Sets the width of the text atlas in px. |
| unsigned | TextAtlasHeight Sets the height of the text atlas in px. |
| bool | PreferSingleColorGlyphAtlas Use a single RGBA8 color atlas for raster glyphs and emojis. When disabled, a single channel atlas will be used for raster glyphs and a separate RGBA8 will be used for emojis. |
| bool | PreferGPUTessellator Use the GPU for vector graphics tessellation. Resulting graphics are stored in intermediate texture atlases. |
| unsigned | MinPathAtlasSize Initial size of the atlas. The atlas grows with a factor of two if a shape does not fit. |
| unsigned | MaxPathAtlasSize Maximum size of the atlas. |
| void * | DeveloperOptions Reserved property for internal usage. Do not use it. |
Public Functions Documentation
function LibraryParams
inline LibraryParams()
Public Attributes Documentation
variable FileSystemReader
IFileSystemReader * FileSystemReader;
System reader used for loading local resources.