Renderbuffers provide the images that can be rendered to by attaching them to the framebuffer as color or depth stencil images. More...

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

Inheritance diagram for kanzi::Renderbuffer:

[legend]

Classes
struct	CreateInfo
	Renderbuffer creation parameters. More...

Public Member Functions
unsigned int	getNativeHandle () const
	Query the graphics device handle of the Renderbuffer.

	Renderbuffer (Domain *domain, const CreateInfo &createInfo, string_view name)
	Construct a Renderbuffer with specified creation parameters.

Public Member Functions inherited from kanzi::Surface
void	attach (Usage usage, APIAttachment apiAttachment, Face face, unsigned int mipmapLevel)
	Attach surface to framebuffer.

unsigned int	getFaceCount () const
	Get number of faces. This should be six for cubemaps and one for everything else.

unsigned int	getFeatures () const
	Get features for Surface.

GraphicsFormat	getFormat () const
	Get GraphicsFormat of Surface.

unsigned int	getHeight () const
	Get height in pixels.

unsigned int	getMipmapLevelCount () const
	Get number of mipmap levels.

unsigned int	getRenderTargetSampleCount () const
	Get number of multisample samples for Surface.

unsigned int	getSliceCount () const
	Get number of slices.

unsigned int	getWidth () const
	Get width in pixels.

Public Member Functions inherited from kanzi::GPUResource
void	destroy ()
	Destroys a GPU resource.

unsigned int	getGPUMemoryUsage () const

Renderer *	getRenderer () const

void	invalidate ()
	Notify resource that graphics context was lost and all GPU resources are invalid.

bool	isDeployed () const

	~GPUResource () override

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static RenderbufferSharedPtr	create (Domain *domain, const CreateInfo &createInfo)
	Create a Renderbuffer with the provided creation parameters.

static RenderbufferSharedPtr	create (Domain *domain, const CreateInfo &createInfo, string_view name)
	Create a Renderbuffer with the provided creation parameters.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
void	attachOverride (Usage usage, APIAttachment apiAttachment, Face face, unsigned int mipmapLevel) override

void	destroyOverride () override
	Destroys all GPU resources.

unsigned int	getFaceCountOverride () const override

unsigned int	getFeaturesOverride () const override

GraphicsFormat	getFormatOverride () const override

unsigned int	getGPUMemoryUsageOverride () const override
	Gets the amount of GPU memory consumed by the resource.

unsigned int	getHeightOverride () const override

unsigned int	getMipmapLevelCountOverride () const override

unsigned int	getRenderTargetSampleCountOverride () const override

unsigned int	getSliceCountOverride () const override

unsigned int	getWidthOverride () const override

void	invalidateOverride () override
	Notifies resource that graphics context was lost and all GPU resources are invalid. Called by invalidate().

bool	isDeployedOverride () const override
	Indicates whether a GPU resource is deployed.

void	reloadOverride () override
	Resource::reloadOverride() implementation.

Protected Member Functions inherited from kanzi::Surface
	Surface (Domain *domain, string_view name)

Protected Member Functions inherited from kanzi::GPUResource
	GPUResource (Domain *domain, string_view name="")
	Constructor.

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

	Resource (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Friends
void	swap (Renderbuffer &buffer1, Renderbuffer &buffer2)

Additional Inherited Members
Public Types inherited from kanzi::Surface
enum	APIAttachment { APIAttachmentColor0 , APIAttachmentColor1 , APIAttachmentColor2 , APIAttachmentColor3 , APIAttachmentDepth , APIAttachmentStencil , APIAttachmentCount , APIAttachmentInvalid }

enum	Face { FacePositiveX , FaceNegativeX , FacePositiveY , FaceNegativeY , FacePositiveZ , FaceNegativeZ , FaceDefault }
	Texture face enumeration. More...

enum	Usage { UsageRenderTarget , UsageMultisampleResolveBlitDestination }

Public Types inherited from kanzi::GPUResource
enum	MemoryType { GpuOnly , GpuAndRam , RamOnly }
	Memory upload and RAM preservation strategy for GPU resources. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Renderbuffers provide the images that can be rendered to by attaching them to the framebuffer as color or depth stencil images.

Unlike textures, you cannot access renderbuffers using the samplers from shaders. When you direct rendering to a framebuffer, the depth and stencil tests require either renderbuffer or texture attached to the framebuffer.

You can read the content of renderbuffers with the ReadPixels() function.

Constructor & Destructor Documentation

◆ Renderbuffer()

kanzi::Renderbuffer::Renderbuffer	(	Domain *	domain,
		const CreateInfo &	createInfo,
		string_view	name )

explicit

Construct a Renderbuffer with specified creation parameters.

Parameters

domain	Domain
createInfo	Renderbuffer creation parameters.
name	Name

Member Function Documentation

◆ create() [1/2]

static RenderbufferSharedPtr kanzi::Renderbuffer::create	(	Domain *	domain,
		const CreateInfo &	createInfo,
		string_view	name )

static

Create a Renderbuffer with the provided creation parameters.

Parameters

domain	Domain
createInfo	Renderbuffer creation parameters.
name

Returns: Newly created Renderbuffer

◆ create() [2/2]

static RenderbufferSharedPtr kanzi::Renderbuffer::create	(	Domain *	domain,
		const CreateInfo &	createInfo )

static

Create a Renderbuffer with the provided creation parameters.

Parameters

domain	Domain
createInfo	Renderbuffer creation parameters.

Returns: Newly created Renderbuffer

◆ getNativeHandle()

unsigned int kanzi::Renderbuffer::getNativeHandle ( ) const

Query the graphics device handle of the Renderbuffer.

Returns: Graphics device handle of the Renderbuffer.

◆ invalidateOverride()

void kanzi::Renderbuffer::invalidateOverride ( )

overrideprotectedvirtual

Notifies resource that graphics context was lost and all GPU resources are invalid. Called by invalidate().

Reimplemented from kanzi::GPUResource.

◆ destroyOverride()

void kanzi::Renderbuffer::destroyOverride ( )

overrideprotectedvirtual

Destroys all GPU resources.

Called by destroy().

Since: Kanzi 3.9.7

Reimplemented from kanzi::GPUResource.

◆ attachOverride()

void kanzi::Renderbuffer::attachOverride	(	Usage	usage,
		APIAttachment	apiAttachment,
		Face	face,
		unsigned int	mipmapLevel )

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getFormatOverride()

GraphicsFormat kanzi::Renderbuffer::getFormatOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getFeaturesOverride()

unsigned int kanzi::Renderbuffer::getFeaturesOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getRenderTargetSampleCountOverride()

unsigned int kanzi::Renderbuffer::getRenderTargetSampleCountOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getWidthOverride()

unsigned int kanzi::Renderbuffer::getWidthOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getHeightOverride()

unsigned int kanzi::Renderbuffer::getHeightOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getSliceCountOverride()

unsigned int kanzi::Renderbuffer::getSliceCountOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getFaceCountOverride()

unsigned int kanzi::Renderbuffer::getFaceCountOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ getMipmapLevelCountOverride()

unsigned int kanzi::Renderbuffer::getMipmapLevelCountOverride ( ) const

overrideprotectedvirtual

Implements kanzi::Surface.

◆ isDeployedOverride()

bool kanzi::Renderbuffer::isDeployedOverride ( ) const

overrideprotectedvirtual

Indicates whether a GPU resource is deployed.

Returns: If the GPU resource is deployed, true, otherwise false.

Implements kanzi::GPUResource.

◆ reloadOverride()

void kanzi::Renderbuffer::reloadOverride ( )

overrideprotectedvirtual

Resource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.

◆ getGPUMemoryUsageOverride()

unsigned int kanzi::Renderbuffer::getGPUMemoryUsageOverride ( ) const

overrideprotectedvirtual

Gets the amount of GPU memory consumed by the resource.

Returns: GPU memory consumption in bytes.

Reimplemented from kanzi::GPUResource.

Friends And Related Symbol Documentation

◆ swap

void swap	(	Renderbuffer &	buffer1,
		Renderbuffer &	buffer2 )

friend

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

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Renderbuffer()

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ getNativeHandle()

◆ invalidateOverride()

◆ destroyOverride()

◆ attachOverride()

◆ getFormatOverride()

◆ getFeaturesOverride()

◆ getRenderTargetSampleCountOverride()

◆ getWidthOverride()

◆ getHeightOverride()

◆ getSliceCountOverride()

◆ getFaceCountOverride()

◆ getMipmapLevelCountOverride()

◆ isDeployedOverride()

◆ reloadOverride()

◆ getGPUMemoryUsageOverride()

Friends And Related Symbol Documentation

◆ swap