#include <kanzi/graphics_3d/gpu_resource.hpp>

Inheritance diagram for kanzi::GPUResource:

Public Member Functions
virtual	~GPUResource () KZ_OVERRIDE

void	deploy ()
	Make graphics API object(s) in the resource usable by preparing GPU objects and data in them. More...

void	undeploy ()
	Free the GPU objects. After this, the resource is not usable for graphics API until deploy() is called again. More...

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

unsigned int	getGPUMemoryUsage () const

Renderer *	getRenderer () const

bool	getDeployOnLoad () const
	Returns true if GPUResource is automatically deployed when loaded. More...

void	setDeployOnLoad (bool value)
	Sets GPUResource automatic deployment on loade on or orr. More...

bool	isDeployed () const

void	deployed ()

void	undeployed ()

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

virtual void	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext) KZ_OVERRIDE
	Function for finishing the loading of the resource. More...

virtual void	unloadOverride () KZ_OVERRIDE
	Unload function for resource. More...

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

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

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)

void	setLoaded ()

kzString	getName () const
	Accessor. More...

void	load ()

void	unload ()

bool	isLoaded () const

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

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

KzuResourceLoadingStrategy	getLoadingStrategy () const

void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)

bool	getKeepAlive () 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...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. 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
	Returns the metaclass of the dynamic type of the object. More...

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

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

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

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

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

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

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

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

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

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

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

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

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

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

Protected Member Functions
	GPUResource (Domain *domain, string_view name="")

virtual void	deployOverride ()
	Make graphics API object(s) in the resource usable by preparing GPU objects and data in them. Called by deploy() More...

virtual void	undeployOverride ()
	Free the GPU objects. After this, the resource is not usable for graphics API until deploy() is called again. Called by undeploy() More...

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

virtual unsigned int	getGPUMemoryUsageOverride () const

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

Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...

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

void	onCopy (const Object &other)

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

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

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

Constructor & Destructor Documentation

virtual kanzi::GPUResource::~GPUResource ( )

virtual

kanzi::GPUResource::GPUResource	(	Domain *	domain,
		string_view	name = `""`
	)

explicitprotected

Member Function Documentation

void kanzi::GPUResource::deploy ( )

Make graphics API object(s) in the resource usable by preparing GPU objects and data in them.

void kanzi::GPUResource::undeploy ( )

Free the GPU objects. After this, the resource is not usable for graphics API until deploy() is called again.

void kanzi::GPUResource::invalidate ( )

Notify resource that graphics context was lost and all GPU resources are invalid.

unsigned int kanzi::GPUResource::getGPUMemoryUsage ( ) const

inline

Renderer* kanzi::GPUResource::getRenderer ( ) const

inline

bool kanzi::GPUResource::getDeployOnLoad ( ) const

Returns true if GPUResource is automatically deployed when loaded.

void kanzi::GPUResource::setDeployOnLoad ( bool value )

Sets GPUResource automatic deployment on loade on or orr.

bool kanzi::GPUResource::isDeployed ( ) const

void kanzi::GPUResource::deployed ( )

inline

void kanzi::GPUResource::undeployed ( )

inline

virtual void kanzi::GPUResource::loadFromKZB	(	const KzuResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

Function for loading the resource from .KZB.

This function is called when loading the data from .KZB file. Implementations should call super class loadFromKZB before reading anything else from inputStream. This function is called from arbitrary loading threads. The parameter threadContext contains thread safe memory manager and a thread specific Property manager which can be locked with the threadLock in the threadContext. This function may not access resource manager or the UIDomain due to race conditions.

Reimplemented from kanzi::Resource.

Reimplemented in kanzi::Mesh, kanzi::Texture, kanzi::Shader, and kanzi::Framebuffer.

virtual void kanzi::GPUResource::finishLoadingOverride ( const KzuResourceLoaderThreadContext * threadContext )

virtual

Function for finishing the loading of the resource.

This function is called in the main thread after loading the data. Implementations should call super class finishLoading first. The parameter threadContext contains thread safe memory manager and the property manager that was used for loading the resource, which can be locked with the threadLock in the threadContext.

Reimplemented from kanzi::Resource.

Reimplemented in kanzi::Mesh.

virtual void kanzi::GPUResource::unloadOverride ( )

virtual

Unload function for resource.

Releases all memory taken by the resource except the resource loader.

Reimplemented from kanzi::Resource.

Reimplemented in kanzi::Mesh, kanzi::Texture, and kanzi::Shader.

virtual unsigned int kanzi::GPUResource::getCPUMemoryUsage ( ) const

virtual

Function for getting the memory usage of a resource.

Reimplemented from kanzi::Resource.