Buffer abstraction. More...

#include <kanzi/core.ui/graphics/gpu_buffer.hpp>

Inheritance diagram for kanzi::GPUBuffer:

Classes
struct	CreateInfo
	CreateInfo The create info for creating a GPUBuffer. More...

Public Member Functions
void	destroyOverride () override
	GPUResource::destroyOverride() implementation.

gfx::AccessFlag	getAccessFlags () const
	Gets the buffer access flags.

gfx::Format	getFormat () const
	Gets the buffer access flags.

size_t	getGPUMemoryUsageOverride () const override
	GPUResource::isDeployedOverride() implementation.

gfx::BufferHandleGuard	getHandle () const
	Gets the Kanzi graphics handle of the buffer.

size_t	getSize () const
	Gets the size of the buffer.

gfx::BufferUsageFlag	getUsage () const
	Gets the buffer usage.

void	invalidateOverride () override
	GPUResource::invalidateOverride() implementation.

bool	isDeployedOverride () const override
	GPUResource::isDeployedOverride() implementation.

void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) override
	Resource::reloadFromKzbOverride() implementation.

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

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

size_t	getGPUMemoryUsage () const
	Gets the amount of GPU memory used by the resource.

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
size_t	getCPUMemoryUsage () const
	Gets the amount of CPU memory used by the 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
void	addDestroyCallback (PropertyObjectDestroyCallback cb)
	Adds a destroy callback that is called when the object is being destroyed.

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

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)
	Removes a property modifier.

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

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)

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

virtual	~PropertyObject ()

Static Public Member Functions
static GPUBufferSharedPtr	create (Domain *domain, const CreateInfo &createInfo, string_view name)
	Creates a GPUBuffer.

static ResourceManager::LoadTaskSharedPtr	createLoadTask (string_view name, KzbFile *kzbFile, ReadOnlyMemoryFilePtr file)
	Creates a task used to create a GPUBuffer from a KZB file.

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
	GPUBuffer (Domain *domain, const CreateInfo &createInfo, 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 size_t	getCPUMemoryUsageOverride () const
	Implementation for getting the amount of CPU memory used by the resource.

virtual void	reloadFromFileOverride (string_view filePath)

	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, AbstractPropertyTypeDescriptor::PropertyStorage &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)
	Acquires a property storage.

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

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)
	Constructs a new local value source entry.

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 &propertyStorage, 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.

template<typename DataType >
void	removePropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Removes a property modifier entry from the property modifier stack and validates the remaining modifiers.

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

void	validatePropertyModifiers (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Validates property modifiers without notifying handlers.

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

Protected Attributes
gfx::AccessFlag	m_access
	Buffer access flags.

gfx::Format	m_format

gfx::BufferHandleGuard	m_handle
	Internal handle wrapped with RAII semantics.

uint32_t	m_size
	Size of the buffer in bytes.

gfx::BufferUsageFlag	m_usage
	Buffer usage flags.

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

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

using	PropertyStorageConstIterator

using	PropertyStorageContainer

using	PropertyStorageIterator

using	PropertyStoragePtr

using	PropertyStorageReverseIterator

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

Detailed Description

Buffer abstraction.

Since

Kanzi 4.0.0

Removed the m_type field.
Removed the getType function.

Kanzi 4.1.0 GPUBuffer now derives from GPUResource.

Kanzi 4.1.0 Removed setData() and setSubData().

Kanzi 4.1.0 Removed all public constructors and added static create function.

Constructor & Destructor Documentation

◆ GPUBuffer()

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

protected

Member Function Documentation

◆ create()

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

inlinestatic

Creates a GPUBuffer.

Parameters

domain
createInfo
name

Precondition: If createInfo.handle is valid createInfo.usage must match the usage createInfo.handle was created with.; If createInfo.handle is valid createInfo.cpuAccess must match the access handle was created with.; If createInfo.handle is valid createInfo.size must match the size handle was created with.; If createInfo.handle is valid, createInfo.initialData must be empty.; createInfo.size must not be 0, unless createInfo.initialData is non-empty, in which case the buffer is sized to the initial data.; The resulting buffer size must not be greater than the maximum value of a uint32_t.; If createInfo.size is not 0, the size of createInfo.initialData must be less than or equal to createInfo.size.; If createInfo.format is not gfx::Format::None and is an uncompressed format, the resulting buffer size must be a multiple of the stride of createInfo.format.; If createInfo.format is not gfx::Format::None and is a compressed format, the resulting buffer size must be a multiple of the block stride of createInfo.format.

Postcondition: If createInfo.size is 0, the buffer size equals the size of createInfo.initialData.

◆ createLoadTask()

static ResourceManager::LoadTaskSharedPtr kanzi::GPUBuffer::createLoadTask	(	string_view	name,
		KzbFile *	kzbFile,
		ReadOnlyMemoryFilePtr	file )

static

Creates a task used to create a GPUBuffer from a KZB file.

Parameters

name	The name of the GPUBuffer.
kzbFile	The KzbFile containing the buffer.
file	The file containing the GPUBuffer data.

Returns: The resource task used to create the GPUBuffer.

Since: Kanzi 4.1.0

◆ getHandle()

gfx::BufferHandleGuard kanzi::GPUBuffer::getHandle ( ) const

inline

Gets the Kanzi graphics handle of the buffer.

Returns: The Kanzi graphics handle of the buffer.

◆ getSize()

size_t kanzi::GPUBuffer::getSize ( ) const

inline

Gets the size of the buffer.

Returns: Size of the buffer.

◆ getUsage()

gfx::BufferUsageFlag kanzi::GPUBuffer::getUsage ( ) const

inline

Gets the buffer usage.

Returns: Usage of the buffer.

Since: Kanzi 4.0.0

◆ getAccessFlags()

gfx::AccessFlag kanzi::GPUBuffer::getAccessFlags ( ) const

inline

Gets the buffer access flags.

Returns: Access of the buffer.

Since: Kanzi 4.1.0

◆ getFormat()

gfx::Format kanzi::GPUBuffer::getFormat ( ) const

inline

Gets the buffer access flags.

Returns: Access of the buffer.

Since: Kanzi 4.1.0

◆ getGPUMemoryUsageOverride()

size_t kanzi::GPUBuffer::getGPUMemoryUsageOverride ( ) const

overridevirtual

GPUResource::isDeployedOverride() implementation.

Reimplemented from kanzi::GPUResource.

◆ isDeployedOverride()

bool kanzi::GPUBuffer::isDeployedOverride ( ) const

overridevirtual

GPUResource::isDeployedOverride() implementation.

Implements kanzi::GPUResource.

◆ invalidateOverride()

void kanzi::GPUBuffer::invalidateOverride ( )

overridevirtual

GPUResource::invalidateOverride() implementation.

Reimplemented from kanzi::GPUResource.

◆ destroyOverride()

void kanzi::GPUBuffer::destroyOverride ( )

overridevirtual

GPUResource::destroyOverride() implementation.

Reimplemented from kanzi::GPUResource.

◆ reloadOverride()

void kanzi::GPUBuffer::reloadOverride ( )

overridevirtual

GPUResource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.

◆ reloadFromKzbOverride()

void kanzi::GPUBuffer::reloadFromKzbOverride	(	KzbFile &	kzbFile,
		ReadOnlyMemoryFile &	file,
		KzbMemoryParser &	parser )

overridevirtual

Resource::reloadFromKzbOverride() implementation.

Reimplemented from kanzi::Resource.

Member Data Documentation

◆ m_handle

gfx::BufferHandleGuard kanzi::GPUBuffer::m_handle

protected

Internal handle wrapped with RAII semantics.

◆ m_usage

gfx::BufferUsageFlag kanzi::GPUBuffer::m_usage

protected

Buffer usage flags.

Since: Kanzi 4.0.0

◆ m_access

gfx::AccessFlag kanzi::GPUBuffer::m_access

protected

Buffer access flags.

Since: Kanzi 4.1.0

◆ m_format

gfx::Format kanzi::GPUBuffer::m_format

protected

◆ m_size

uint32_t kanzi::GPUBuffer::m_size

protected

Size of the buffer in bytes.

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

kanzi/core.ui/graphics/gpu_buffer.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GPUBuffer()

Member Function Documentation

◆ create()

◆ createLoadTask()

◆ getHandle()

◆ getSize()

◆ getUsage()

◆ getAccessFlags()

◆ getFormat()

◆ getGPUMemoryUsageOverride()

◆ isDeployedOverride()

◆ invalidateOverride()

◆ destroyOverride()

◆ reloadOverride()

◆ reloadFromKzbOverride()

Member Data Documentation

◆ m_handle

◆ m_usage

◆ m_access

◆ m_format

◆ m_size