kanzi::Renderbuffer::CreateInfo Struct Reference

Renderbuffer creation parameters. More...

#include <kanzi/core.ui/graphics2d/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 ()=default
	Default constructor.
	CreateInfo (size_t width, size_t height, GraphicsFormat format)
	Constructor for Renderbuffer creation parameters.
	CreateInfo (size_t width, size_t height, GraphicsFormat format, size_t sampleCount)
	Constructor for Renderbuffer creation parameters.
	CreateInfo (size_t width, size_t height, GraphicsFormat format, size_t sampleCount, bool transient)
	Constructor for Renderbuffer creation parameters.
bool	operator!= (const CreateInfo &other) const
	Not equals operator.
bool	operator== (const CreateInfo &other) const
	Equals operator.
Status	validate (Renderer &renderer) const
	Perform validation of renderbuffer creation parameters.

Public Attributes
GraphicsFormat	format
	Requested GraphicsFormat for the Renderbuffer.
size_t	height
	Requested height for the Renderbuffer in pixels.
size_t	sampleCount
	Requested number of samples for the Renderbuffer.
bool	transient
	Renderbuffer transient flag.
size_t	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/4]

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

explicitdefault

Default constructor.

CreateInfo() [2/4]

kanzi::Renderbuffer::CreateInfo::CreateInfo ( size_t width, size_t height, GraphicsFormat format, size_t sampleCount, bool transient )

inlineexplicit

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.
transient	Renderbuffer transient status.

Since

Kanzi 4.0.0

CreateInfo() [3/4]

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

inlineexplicit

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() [4/4]

kanzi::Renderbuffer::CreateInfo::CreateInfo ( size_t width, size_t height, GraphicsFormat format )

inlineexplicit

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.

Since

Kanzi 4.0.0 changed the type of the renderer parameter to Renderer&.

operator==()

bool kanzi::Renderbuffer::CreateInfo::operator== ( const CreateInfo & other ) const

inline

Equals operator.

Parameters

other

Create info structure to compare against.

Returns

If the structures are matching true, false otherwise.

Since

Kanzi 4.0.0

operator!=()

bool kanzi::Renderbuffer::CreateInfo::operator!= ( const CreateInfo & other ) const

inline

Not equals operator.

Parameters

other

Create info structure to compare against.

Returns

If the structures are matching false, true otherwise.

Since

Kanzi 4.0.0

Member Data Documentation

width

size_t kanzi::Renderbuffer::CreateInfo::width

Requested width for the Renderbuffer in pixels.

Since

Kanzi 4.0.0 changed the type to size_t.

height

size_t kanzi::Renderbuffer::CreateInfo::height

Requested height for the Renderbuffer in pixels.

Since

Kanzi 4.0.0 changed the type to size_t.

format

GraphicsFormat kanzi::Renderbuffer::CreateInfo::format

Requested GraphicsFormat for the Renderbuffer.

sampleCount

size_t kanzi::Renderbuffer::CreateInfo::sampleCount

Requested number of samples for the Renderbuffer.

Since

Kanzi 4.0.0 changed the type to size_t.

transient

bool kanzi::Renderbuffer::CreateInfo::transient

Renderbuffer transient flag.

Transient renderbuffers are resolved immediately after rendering.

Since

Kanzi 4.0.0

---

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

• kanzi/core.ui/graphics2d/renderbuffer.hpp