kanzi::Renderbuffer::CreateInfo Struct Reference

Renderbuffer creation parameters. More...

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

Public Types
enum	Status {   StatusUnsupportedFormat , StatusInvalidMinimumSize , StatusInvalidMaximumSize , StatusUnsupportedSampleCount ,   StatusValid }
	Status of Renderbuffer creation parameters, returned as result of validate() More...

Public Member Functions
	CreateInfo ()
	Constructor for Renderbuffer creation parameters.
	CreateInfo (unsigned int width, unsigned int height, GraphicsFormat format)
	Constructor for Renderbuffer creation parameters.
	CreateInfo (unsigned int width, unsigned int height, GraphicsFormat format, unsigned int sampleCount)
	Constructor for Renderbuffer creation parameters.
Status	validate (Renderer *renderer) const
	Perform validation of renderbuffer creation parameters.

Public Attributes
GraphicsFormat	format
	Requested GraphicsFormat for the Renderbuffer.
unsigned int	height
	Requested height for the Renderbuffer in pixels.
unsigned int	sampleCount
	Requested number of samples for the Renderbuffer.
unsigned int	width
	Requested width for the Renderbuffer in pixels.

Detailed Description

Renderbuffer creation parameters.

Member Enumeration Documentation

Status

enum kanzi::Renderbuffer::CreateInfo::Status

Status of Renderbuffer creation parameters, returned as result of validate()

Enumerator
StatusUnsupportedFormat	Renderbuffer creation parameters use GraphicsFormat that is not supported by the graphics device.
StatusInvalidMinimumSize	Renderbuffer creation parameters request Renderbuffer with zero width and/or height. Minimum size of Renderbuffers is 1 by 1.
StatusInvalidMaximumSize	Renderbuffer creation parameters request renderbuffer size that exceeds size supported by the graphics device.
StatusUnsupportedSampleCount	Renderbuffer creation parameters request number of samples that exceeds number of samples supported by the graphics device.
StatusValid	Rebderbuffer creation parameters are valid and can be used to create a Renderbuffer.

Constructor & Destructor Documentation

CreateInfo() [1/3]

kanzi::Renderbuffer::CreateInfo::CreateInfo ( )

explicit

Constructor for Renderbuffer creation parameters.

CreateInfo() [2/3]

kanzi::Renderbuffer::CreateInfo::CreateInfo ( unsigned int width, unsigned int height, GraphicsFormat format, unsigned int sampleCount )

explicit

Constructor for Renderbuffer creation parameters.

Parameters

width	Width of renderbuffer in pixels.
height	Height of renderbuffer in pixels.
format	Requested GraphicsFormat for the Renderbuffer.
sampleCount	Number of multisample samples.

CreateInfo() [3/3]

kanzi::Renderbuffer::CreateInfo::CreateInfo ( unsigned int width, unsigned int height, GraphicsFormat format )

explicit

Constructor for Renderbuffer creation parameters.

Parameters

width	Width of renderbuffer in pixels.
height	Height of renderbuffer in pixels.
format	Requested GraphicsFormat for the Renderbuffer.

Member Function Documentation

validate()

Status kanzi::Renderbuffer::CreateInfo::validate

(

Renderer *

renderer

)

const

Perform validation of renderbuffer creation parameters.

You can call validate() to see if renderbuffer creation parameters are valid before you pass the creation parameters to Renderbuffer::create().

Parameters

renderer

Renderer to validate with.

Returns

StatusValid if these creation parameters can be used to create a new Renderbuffer. Otherwise a reason code for why this CreateInfo cannot be used to create a new Renderbuffer.

Member Data Documentation

width

unsigned int kanzi::Renderbuffer::CreateInfo::width

Requested width for the Renderbuffer in pixels.

height

unsigned int kanzi::Renderbuffer::CreateInfo::height

Requested height for the Renderbuffer in pixels.

format

GraphicsFormat kanzi::Renderbuffer::CreateInfo::format

Requested GraphicsFormat for the Renderbuffer.

sampleCount

unsigned int kanzi::Renderbuffer::CreateInfo::sampleCount

Requested number of samples for the Renderbuffer.

---

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

• kanzi/core.ui/platform/graphics_backend/gl/renderbuffer.hpp