kanzi::Renderer::RendererSettings Struct Reference

Settings structure for 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 (kzUint vertexPoolSize, kzUint indexPoolSize, MultisamplePreference multisample)
 Constructor. More...
 

Public Attributes

unsigned int vertexBufferPoolSize
 Size of vertex buffer pool for GPU buffer manager. More...
 
unsigned int indexBufferPoolSize
 Size of index buffer pool for GPU buffer manager. More...
 
MultisamplePreference multisamplePreference
 Preference when selecting the multisampling method. More...
 

Static Public Attributes

static const unsigned int DefaultVertexBufferPoolSize
 Default vertex buffer pool size. More...
 
static const unsigned int DefaultIndexBufferPoolSize
 Default index buffer pool size. More...
 

Detailed Description

Settings structure for renderer construction.

Member Enumeration Documentation

Multisample preferencce.

Enumerator
MultisamplePreferenceNone 

No preference.

MultisamplePreferenceBlit 

Blit from renderbuffer.

MultisamplePreferenceExplicit 

Explicit multisample.

Samples must be accessed explicitly in shader.

MultisamplePreferenceImplicit 

Implicit multisample.

Resolved automatically.

Constructor & Destructor Documentation

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

Default constructor.

kanzi::Renderer::RendererSettings::RendererSettings ( kzUint  vertexPoolSize,
kzUint  indexPoolSize,
MultisamplePreference  multisample 
)
inlineexplicit

Constructor.

Parameters
vertexpoolSizePool size for vertex buffers if using GPU buffer manager.
indexPoolSizePool size for index buffers if using GPU buffer manager.
implicitMultisampleWhether to prefer implicit multisample method over renderbuffer blit if available.

Member Data Documentation

const unsigned int kanzi::Renderer::RendererSettings::DefaultVertexBufferPoolSize
static

Default vertex buffer pool size.

const unsigned int kanzi::Renderer::RendererSettings::DefaultIndexBufferPoolSize
static

Default index buffer pool size.

unsigned int kanzi::Renderer::RendererSettings::vertexBufferPoolSize

Size of vertex buffer pool for GPU buffer manager.

unsigned int kanzi::Renderer::RendererSettings::indexBufferPoolSize

Size of index buffer pool for GPU buffer manager.

MultisamplePreference kanzi::Renderer::RendererSettings::multisamplePreference

Preference when selecting the multisampling method.


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