#include <kanzi/graphics_3d/composer.hpp>

Inheritance diagram for kanzi::Composer:

Public Types
typedef vector< ComposerSharedPtr >	ComposerContainer

Public Member Functions
	Composer (Domain *domain, string_view name="")

virtual void	applyOverride (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

virtual void	requiresDepthBuffer (bool &out_allowDepthClear, bool &out_requiresDepth) const

virtual void	initialize ()

virtual void	reset ()

void	apply (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

void	setRenderTarget (FramebufferSharedPtr renderTarget)

FramebufferSharedPtr	getRenderTarget () const

ComposerContainer::const_iterator	beginChildren () const

ComposerContainer::const_iterator	endChildren () const

void	addChild (ComposerSharedPtr childComposer)
	Adds a child to composer. More...

void	addChildAtIndex (size_t index, ComposerSharedPtr childComposer)
	Add child composer at given index in parent. More...

void	removeChild (ComposerSharedPtr childComposer)
	Removes a child from composer. More...

void	removeAllChildren ()
	Removes all m_children from composer. More...

ComposerSharedPtr	getChildComposer (size_t index)
	Gets a child composer from composer at given index. If index is out of range 0 is returned. More...

size_t	getChildCount () const
	Returns the amount of render passes in composer. More...

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

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

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

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

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

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

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

Static Public Member Functions
static ComposerSharedPtr	create (Domain *domain, string_view name="")

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 Member Functions
void	applyChildren (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

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

Member Typedef Documentation

typedef vector<ComposerSharedPtr> kanzi::Composer::ComposerContainer

Constructor & Destructor Documentation

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

explicit

Member Function Documentation

static ComposerSharedPtr kanzi::Composer::create	(	Domain *	domain,
		string_view	name = `""`
	)

static

virtual void kanzi::Composer::applyOverride	(	Renderer3D *	renderer,
		const TransformedScene3D *	transformedScene,
		RenderContextStack &	renderContextStack
	)

virtual

Reimplemented in kanzi::Renderpass, and KzuDebugComposer.

virtual void kanzi::Composer::requiresDepthBuffer	(	bool &	out_allowDepthClear,
		bool &	out_requiresDepth
	)		const

virtual

Reimplemented in kanzi::Renderpass.

virtual void kanzi::Composer::initialize ( )

inlinevirtual

Reimplemented in kanzi::Renderpass.

virtual void kanzi::Composer::reset ( )

virtual

void kanzi::Composer::apply	(	Renderer3D *	renderer,
		const TransformedScene3D *	transformedScene,
		RenderContextStack &	renderContextStack
	)

void kanzi::Composer::setRenderTarget ( FramebufferSharedPtr renderTarget )

FramebufferSharedPtr kanzi::Composer::getRenderTarget ( ) const

ComposerContainer::const_iterator kanzi::Composer::beginChildren ( ) const

inline

ComposerContainer::const_iterator kanzi::Composer::endChildren ( ) const

inline

void kanzi::Composer::addChild ( ComposerSharedPtr childComposer )

Adds a child to composer.

void kanzi::Composer::addChildAtIndex	(	size_t	index,
		ComposerSharedPtr	childComposer
	)

Add child composer at given index in parent.

void kanzi::Composer::removeChild ( ComposerSharedPtr childComposer )

Removes a child from composer.

void kanzi::Composer::removeAllChildren ( )

Removes all m_children from composer.

ComposerSharedPtr kanzi::Composer::getChildComposer ( size_t index )

Gets a child composer from composer at given index. If index is out of range 0 is returned.

size_t kanzi::Composer::getChildCount ( ) const

Returns the amount of render passes in composer.

virtual void kanzi::Composer::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::Renderpass.

void kanzi::Composer::applyChildren	(	Renderer3D *	renderer,
		const TransformedScene3D *	transformedScene,
		RenderContextStack &	renderContextStack
	)

protected

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

kanzi/graphics_3d/composer.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation