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:

Classes
struct	CreateInfo
	Renderbuffer creation parameters. More...

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

unsigned int	getNativeHandle () const
	Query the graphics device handle of the Renderbuffer. More...

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

GraphicsFormat	getFormat () const
	Get GraphicsFormat of Surface. More...

unsigned int	getFeatures () const
	Get features for Surface. More...

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

unsigned int	getWidth () const
	Get width in pixels. More...

unsigned int	getHeight () const
	Get height in pixels. More...

unsigned int	getSliceCount () const
	Get number of slices. More...

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

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

Public Member Functions inherited from kanzi::GPUResource
virtual	~GPUResource () KZ_OVERRIDE

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

unsigned int	getGPUMemoryUsage () const

Renderer *	getRenderer () const

bool	isDeployed () const

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

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

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

void	setUrl (string_view url)
	Sets the resource URL. More...

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

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

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

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

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

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

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

void	removeKzbProperties ()

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

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. More...

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

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

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

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

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

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

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

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

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

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

void	validatePropertyModifiers (AbstractPropertyType propertyType)

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

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

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

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

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

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

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

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

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

Protected Member Functions
virtual void	invalidateOverride () KZ_OVERRIDE
	Notify resource that graphics context was lost and all GPU resources are invalid. Called by invalidate() More...

virtual void	attachOverride (Usage usage, APIAttachment apiAttachment, Face face, unsigned int mipmapLevel) KZ_OVERRIDE

virtual GraphicsFormat	getFormatOverride () const KZ_OVERRIDE

virtual unsigned int	getFeaturesOverride () const KZ_OVERRIDE

virtual unsigned int	getRenderTargetSampleCountOverride () const KZ_OVERRIDE

virtual unsigned int	getWidthOverride () const KZ_OVERRIDE

virtual unsigned int	getHeightOverride () const KZ_OVERRIDE

virtual unsigned int	getSliceCountOverride () const KZ_OVERRIDE

virtual unsigned int	getFaceCountOverride () const KZ_OVERRIDE

virtual unsigned int	getMipmapLevelCountOverride () const KZ_OVERRIDE

virtual bool	isDeployedOverride () const KZ_OVERRIDE

virtual void	reloadOverride () KZ_OVERRIDE
	Resource::reloadOverride() implementation. More...

virtual unsigned int	getGPUMemoryUsageOverride () const KZ_OVERRIDE

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="")

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

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

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

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

void	onCopy (const Object &other)

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

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

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

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

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

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

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

Additional Inherited Members
Public Types inherited from kanzi::Surface
enum	Usage { UsageRenderTarget, UsageMultisampleResolveBlitDestination }

enum	APIAttachment { APIAttachmentColor0, APIAttachmentColor1, APIAttachmentColor2, APIAttachmentColor3, APIAttachmentDepth, APIAttachmentStencil, APIAttachmentCount, APIAttachmentInvalid }

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

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 intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

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

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

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

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

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

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

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

Query the graphics device handle of the Renderbuffer.

Returns: Graphics device handle of the Renderbuffer.

virtual void kanzi::Renderbuffer::invalidateOverride ( )

protectedvirtual

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

Reimplemented from kanzi::GPUResource.

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

protectedvirtual

Implements kanzi::Surface.

virtual GraphicsFormat kanzi::Renderbuffer::getFormatOverride ( ) const

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

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

protectedvirtual

Implements kanzi::Surface.

virtual bool kanzi::Renderbuffer::isDeployedOverride ( ) const

protectedvirtual

Implements kanzi::GPUResource.

virtual void kanzi::Renderbuffer::reloadOverride ( )

protectedvirtual

Resource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.

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

protectedvirtual

Reimplemented from kanzi::GPUResource.

Friends And Related Function Documentation

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

Member Function Documentation

Friends And Related Function Documentation