Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::Renderer::RendererSettings Struct Reference

Settings structure for the renderer construction. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/renderer.hpp>

Public Types

enum  MultisamplePreference { MultisamplePreferenceNone, MultisamplePreferenceBlit, MultisamplePreferenceExplicit, MultisamplePreferenceImplicit }
 Multisample preferencce. More...
 

Public Member Functions

 RendererSettings ()
 Default constructor. More...
 
 RendererSettings (MultisamplePreference multisample)
 Constructor. More...
 

Public Attributes

MultisamplePreference multisamplePreference
 Preference when selecting the multisampling method. More...
 
bool shaderBinaryCacheCollisionCheck
 Indicates whether to check for hash collisions in shader binaries. More...
 
string shaderBinaryCacheDirectory
 Shader binary cache directory. More...
 
bool shaderBinaryCacheEnabled
 Indicates whether to cache shader binaries. More...
 
bool shaderBinaryCacheReadOnly
 Indicates whether the cache is read-only. More...
 

Detailed Description

Settings structure for the renderer construction.

Member Enumeration Documentation

Multisample preferencce.

Enumerator
MultisamplePreferenceNone 

No preference.

MultisamplePreferenceBlit 

Blits from the renderbuffer.

MultisamplePreferenceExplicit 

Uses explicit multisampling.

The samples must be accessed explicitly in the shader.

MultisamplePreferenceImplicit 

Uses implicit multisampling, that is, multisampled rendering to a texture without requiring an explicit resolve of the multisample data.

Constructor & Destructor Documentation

kanzi::Renderer::RendererSettings::RendererSettings ( )
inlineexplicit

Default constructor.

kanzi::Renderer::RendererSettings::RendererSettings ( MultisamplePreference  multisample)
inlineexplicit

Constructor.

Parameters
multisampleMultisample preference setting.

Member Data Documentation

MultisamplePreference kanzi::Renderer::RendererSettings::multisamplePreference

Preference when selecting the multisampling method.

bool kanzi::Renderer::RendererSettings::shaderBinaryCacheEnabled

Indicates whether to cache shader binaries.

By default, the application does not cache shader binaries.

Since
Kanzi 3.9.8
bool kanzi::Renderer::RendererSettings::shaderBinaryCacheReadOnly

Indicates whether the cache is read-only.

By default, Kanzi updates the cache.

Since
Kanzi 3.9.8
bool kanzi::Renderer::RendererSettings::shaderBinaryCacheCollisionCheck

Indicates whether to check for hash collisions in shader binaries.

By default, the application does not check for hash collisions.

Since
Kanzi 3.9.8
string kanzi::Renderer::RendererSettings::shaderBinaryCacheDirectory

Shader binary cache directory.

Since
Kanzi 3.9.8

The documentation for this struct was generated from the following file: