renoir::RenderingLibraryParams
Initialization parameters of the Rendering library.
#include <CoherentRenderingLibrary.h>
Inherits from renoir::CommonRenderingLibraryParams
Public Functions
| Name | |
|---|---|
| RenderingLibraryParams() |
Public Attributes
| Name | |
|---|---|
| IAllocator * | Allocator Memory allocator for all operations of the library. Must not be null. |
| ITracer * | Tracer Renoir will send trace events through the tracer when a trace is started through Library::StartTrace. |
| IProfileMarkersTracer * | ProfileTracer |
| 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. |
| 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. |
| IFileManipulator * | FileManipulator System reader used for loading local resources. |
| void * | DeveloperOptions Reserved property for internal usage. Do not use it. |
Additional inherited members
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 lirary 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. |
Public Functions Documentation
function RenderingLibraryParams
inline RenderingLibraryParams()
Public Attributes Documentation
variable Allocator
IAllocator * Allocator;
Memory allocator for all operations of the library. Must not be null.
variable Tracer
ITracer * Tracer;
Renoir will send trace events through the tracer when a trace is started through Library::StartTrace.
variable ProfileTracer
IProfileMarkersTracer * ProfileTracer;
variable LoggingSeverity
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.
variable LogHandler
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.
variable PerformanceHandler
Profile::IPerformanceHandler * PerformanceHandler;
Handler provided by the application that will receive performance warning messages.
variable FileManipulator
IFileManipulator * FileManipulator;
System reader used for loading local resources.
variable DeveloperOptions
void * DeveloperOptions;
Reserved property for internal usage. Do not use it.