Surfaces provide images for Framebuffers where to render to. More...

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

Inheritance diagram for kanzi::Surface:

Public Types
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

Public Member Functions
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 ()

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

virtual unsigned int	getFaceCountOverride () const =0

virtual unsigned int	getFeaturesOverride () const =0

virtual GraphicsFormat	getFormatOverride () const =0

virtual unsigned int	getHeightOverride () const =0

virtual unsigned int	getMipmapLevelCountOverride () const =0

virtual unsigned int	getRenderTargetSampleCountOverride () const =0

virtual unsigned int	getSliceCountOverride () const =0

virtual unsigned int	getWidthOverride () const =0

	Surface (Domain *domain, string_view name)

Protected Member Functions inherited from kanzi::GPUResource
virtual void	destroyOverride ()
	Destroys all GPU resources.

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

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

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

virtual bool	isDeployedOverride () const =0
	Indicates whether a GPU resource is deployed.

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)

virtual void	reloadOverride ()

	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.

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

Surfaces provide images for Framebuffers where to render to.

Member Enumeration Documentation

◆ Usage

enum kanzi::Surface::Usage

Enumerator
UsageRenderTarget	Framebuffer is used for rendering and potentially as multisample resolve source.
UsageMultisampleResolveBlitDestination	Framebuffer is used as multisample resolve destination.

◆ APIAttachment

enum kanzi::Surface::APIAttachment

Enumerator
APIAttachmentColor0	Color buffer 0 GL attachment (OpenGL ES 2 compatible)
APIAttachmentColor1	Color buffer 1 GL attachment (Requires OpenGL ES 3) Color buffer 2 GL attachment (Requires OpenGL ES 3)
APIAttachmentColor2
APIAttachmentColor3	Color buffer 3 GL attachment (Requires OpenGL ES 3)
APIAttachmentDepth	Depth buffer GL attachment.
APIAttachmentStencil	Stencil buffer GL attachment.
APIAttachmentCount
APIAttachmentInvalid	Invalid GL attachment.

◆ Face

enum kanzi::Surface::Face

Texture face enumeration.

Enumerator
FacePositiveX	Positive X.
FaceNegativeX	Negative X.
FacePositiveY	Positive Y.
FaceNegativeY	Negative Y.
FacePositiveZ	Positive Z.
FaceNegativeZ	Negative Z.
FaceDefault	Default face, for non-cubemap textures.

Constructor & Destructor Documentation

◆ Surface()

kanzi::Surface::Surface	(	Domain *	domain,
		string_view	name )

inlineexplicitprotected

Member Function Documentation

◆ attach()

void kanzi::Surface::attach	(	Usage	usage,
		APIAttachment	apiAttachment,
		Face	face,
		unsigned int	mipmapLevel )

Attach surface to framebuffer.

Parameters

usage	The purpose of the surface.
apiAttachment	Attachment point in framebuffer where surface will be attached to.
face	Face of surface to attach. Ignored for non-cubemap texture or non-texture surfaces.
mipmapLevel	Mipmap level of surface to attach. Ignored for non-texture surfaces.

◆ getFormat()

GraphicsFormat kanzi::Surface::getFormat ( ) const

Get GraphicsFormat of Surface.

◆ getFeatures()

unsigned int kanzi::Surface::getFeatures ( ) const

Get features for Surface.

See also: GraphicsFormatFeature

◆ getRenderTargetSampleCount()

unsigned int kanzi::Surface::getRenderTargetSampleCount ( ) const

Get number of multisample samples for Surface.

Returns: Surface multisampling count.

◆ getWidth()

unsigned int kanzi::Surface::getWidth ( ) const

Get width in pixels.

◆ getHeight()

unsigned int kanzi::Surface::getHeight ( ) const

Get height in pixels.

◆ getSliceCount()

unsigned int kanzi::Surface::getSliceCount ( ) const

Get number of slices.

◆ getFaceCount()

unsigned int kanzi::Surface::getFaceCount ( ) const

Get number of faces. This should be six for cubemaps and one for everything else.

◆ getMipmapLevelCount()

unsigned int kanzi::Surface::getMipmapLevelCount ( ) const

Get number of mipmap levels.

◆ attachOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getFormatOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getFeaturesOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getRenderTargetSampleCountOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getWidthOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getHeightOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getSliceCountOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getFaceCountOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

◆ getMipmapLevelCountOverride()

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

protectedpure virtual

Implemented in kanzi::Renderbuffer, and kanzi::Texture.

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

kanzi/core.ui/graphics2d/surface.hpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Usage

◆ APIAttachment

◆ Face

Constructor & Destructor Documentation

◆ Surface()

Member Function Documentation

◆ attach()

◆ getFormat()

◆ getFeatures()

◆ getRenderTargetSampleCount()

◆ getWidth()

◆ getHeight()

◆ getSliceCount()

◆ getFaceCount()

◆ getMipmapLevelCount()

◆ attachOverride()

◆ getFormatOverride()

◆ getFeaturesOverride()

◆ getRenderTargetSampleCountOverride()

◆ getWidthOverride()

◆ getHeightOverride()

◆ getSliceCountOverride()

◆ getFaceCountOverride()

◆ getMipmapLevelCountOverride()