Framebuffer allows the rendering to the user-specified texture or renderbuffer, instead of rendering directly to the window. More...

#include <kanzi/core.ui/graphics2d/framebuffer.hpp>

Inheritance diagram for kanzi::Framebuffer:

[legend]

Classes
struct	Attachment
	Framebuffer attachment settings. More...

struct	CreateInfo
	Framebuffer creation parameters. More...

Public Types
enum	AttachmentBit { AttachmentBitColor0, AttachmentBitColor1, AttachmentBitColor2, AttachmentBitColor3, AttachmentBitDepthStencil }

enum	AttachmentPoint { AttachmentPointColor0, AttachmentPointColor1, AttachmentPointColor2, AttachmentPointColor3, AttachmentPointDepthStencil, AttachmentPointCount }

enum	Target { TargetReadAndDraw, TargetRead, TargetDraw }
	Framebuffer target selects draw or read framebuffer, or both. 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 PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
	Framebuffer (Domain *domain, const CreateInfo &createInfo, string_view name)

SurfaceSharedPtr	getAttachment (AttachmentPoint attachment) const
	Returns the attachment from the framebuffer for the specified attachment point. More...

unsigned int	getCommonHeight () const
	Returns the common height of the framebuffer. More...

unsigned int	getCommonSampleCount () const
	Returns the common sample count of the framebuffer. More...

unsigned int	getCommonWidth () const
	Returns the common width of the framebuffer. More...

NativeFramebufferHandle	getNativeHandle () const
	Returns the object handle for the framebuffer. More...

TextureSharedPtr	getTexture (AttachmentPoint attachment) const
	Returns the attachment as texture from the framebuffer. More...

Surface::Usage	getUsage () const
	Returns Framebuffer usage. More...

bool	hasAttachment (AttachmentPoint attachmentPoint) const
	Tell if framebuffer has given attachment. More...

Public Member Functions inherited from kanzi::GPUResource
unsigned int	getGPUMemoryUsage () const

Renderer *	getRenderer () const

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

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

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

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

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

void	reload ()

void	reloadFromFile (string_view filePath)

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

	Resource (Domain *domain, string_view name)

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

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

	~Resource () override

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

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

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

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

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

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

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

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

	Object (Domain *domain)

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

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

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

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	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, void ownerPointer)

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

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

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

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

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

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. 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 >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. 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...

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties ()

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static FramebufferSharedPtr	create (Domain *domain, const CreateInfo &createInfo, string_view name)
	Creates the framebuffer from specified attachments. More...

static FramebufferSharedPtr	create (Domain *domain, const CreateInfo &createInfo)
	Creates the framebuffer from specified attachments. 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
void	invalidateOverride () override
	Notify resource that graphics context was lost and all GPU resources are invalid. Called by invalidate() More...

bool	isDeployedOverride () const override

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

Protected Member Functions inherited from kanzi::GPUResource
virtual unsigned int	getGPUMemoryUsageOverride () const

	GPUResource (Domain *domain, string_view name="")

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)

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

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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

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

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

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

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

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

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

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

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

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Additional Inherited Members
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

Framebuffer allows the rendering to the user-specified texture or renderbuffer, instead of rendering directly to the window.

Framebuffer must have at least one Surface (Texture or Renderbuffer) attached to it. Depth and stencil tests require that a Surface (typically Renderbuffer) is attached to the depth and stencil attachment point.

Member Enumeration Documentation

enum kanzi::Framebuffer::AttachmentPoint

Enumerator
AttachmentPointColor0	Color buffer 0 framebuffer attachment point (OpenGL ES 2 compatible)
AttachmentPointColor1	Color buffer 1 framebuffer attachment point (Requires OpenGL ES 3)
AttachmentPointColor2	Color buffer 2 framebuffer attachment point (Requires OpenGL ES 3)
AttachmentPointColor3	Color buffer 3 framebuffer attachment point (Requires OpenGL ES 3)
AttachmentPointDepthStencil	Depth and stencil framebuffer attachment point.
AttachmentPointCount	Number of attachment points in Framebuffer.

enum kanzi::Framebuffer::AttachmentBit

Enumerator
AttachmentBitColor0
AttachmentBitColor1
AttachmentBitColor2
AttachmentBitColor3
AttachmentBitDepthStencil

enum kanzi::Framebuffer::Target

Framebuffer target selects draw or read framebuffer, or both.

Enumerator
TargetReadAndDraw	Both read and draw framebuffers.
TargetRead	Read framebuffe.
TargetDraw	Draw framebuffer.

Constructor & Destructor Documentation

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

explicit

Member Function Documentation

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

static

Creates the framebuffer from specified attachments.

The framebuffer is deployed and ready to use.

Parameters

domain	Domain for the graphics resource
createInfo	Width of the framebuffer
name	Name

Returns: The created framebuffer

static FramebufferSharedPtr kanzi::Framebuffer::create	(	Domain *	domain,
		const CreateInfo &	createInfo
	)

static

Creates the framebuffer from specified attachments.

The framebuffer is deployed and ready to use.

Parameters

domain	Domain for the graphics resource
createInfo	Width of the framebuffer

Returns: The created framebuffer

SurfaceSharedPtr kanzi::Framebuffer::getAttachment ( AttachmentPoint attachment ) const

Returns the attachment from the framebuffer for the specified attachment point.

Parameters

attachment Attachment point to examine

Returns: The attachment for the specified attachment point in the framebuffer

TextureSharedPtr kanzi::Framebuffer::getTexture ( AttachmentPoint attachment ) const

Returns the attachment as texture from the framebuffer.

Parameters

attachment Attachment point to query from the framebuffer. For OpenGL ES 2, either Framebuffer::AttachmentColor0 or Framebuffer::AttachmentDepthStencil.

Returns: Texture attached to the specified attachment point, or empty if there is no texture.

unsigned int kanzi::Framebuffer::getCommonWidth ( ) const

Returns the common width of the framebuffer.

Returns: The width of the framebuffer in pixels

unsigned int kanzi::Framebuffer::getCommonHeight ( ) const

Returns the common height of the framebuffer.

Returns: The height of the framebuffer in pixels

unsigned int kanzi::Framebuffer::getCommonSampleCount ( ) const

Returns the common sample count of the framebuffer.

Returns: The number of multisample samples in the framebuffer. In OpenGL ES 2 this is zero.

Surface::Usage kanzi::Framebuffer::getUsage ( ) const

Returns Framebuffer usage.

Returns: Usage for framebuffer.

NativeFramebufferHandle kanzi::Framebuffer::getNativeHandle ( ) const

Returns the object handle for the framebuffer.

Returns: framebuffer object handle

bool kanzi::Framebuffer::hasAttachment ( AttachmentPoint attachmentPoint ) const

inline

Tell if framebuffer has given attachment.

Parameters

attachment Attachment to check for.

Returns: True if yes, false if no.

void kanzi::Framebuffer::invalidateOverride ( )

overrideprotectedvirtual

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

Reimplemented from kanzi::GPUResource.

bool kanzi::Framebuffer::isDeployedOverride ( ) const

overrideprotectedvirtual

Implements kanzi::GPUResource.

void kanzi::Framebuffer::reloadOverride ( )

overrideprotectedvirtual

Resource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.

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

kanzi/core.ui/graphics2d/framebuffer.hpp


Kanzi Engine API

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation