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

#include <kanzi/graphics_3d/surface.hpp>

Inheritance diagram for kanzi::Surface:

Public Types
enum	APIAttachment { APIAttachmentColor0, APIAttachmentColor1, APIAttachmentColor2, APIAttachmentColor3, APIAttachmentDepth, APIAttachmentStencil, APIAttachmentInvalid }

Public Member Functions
virtual bool	isRenderable (unsigned int face, unsigned int mipLevel) const =0

GraphicsFormat	getFormat () const
	Get GraphicsFormat of Surface. More...

unsigned int	getSampleCount () const
	Get number multisample samples. 0 means multisampling is disabled. More...

unsigned int	getWidth () const
	Get width in pixels. More...

unsigned int	getHeight () const
	Get height in pixels. More...

unsigned int	getSliceCount () const
	Get number of slices. More...

unsigned int	getFaceCount () const
	Get number of faces. This should be six for cubemaps and one for everything else. More...

unsigned int	getMipLevelCount () const
	Get number of mipmap levels. More...

bool	isWellFormed () const
	Return true if Surface is valid shape and format. More...

virtual	~Surface () KZ_OVERRIDE

virtual void	attach (Framebuffer &framebuffer, APIAttachment apiAttachment, unsigned int face, unsigned int mipLevel)=0

Public Member Functions inherited from kanzi::GPUResource
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
	Surface (Domain *domain, string_view name="")

unsigned int	getGpuMemoryUsageEstimate () const

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

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

void	configure (GraphicsFormat format, unsigned int sampleCount, unsigned int width, unsigned int height, unsigned int sliceCount, unsigned int faceCount, unsigned int mipLevelCount)
	Set format and shape for the Surface. More...

void	setFaceCount (unsigned int value)

void	setSliceCount (unsigned int value)

Protected Member Functions inherited from kanzi::GPUResource
	GPUResource (Domain *domain, string_view name="")

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

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

Detailed Description

Surfaces provide images for Framebuffers where to render to.

Member Enumeration Documentation

enum kanzi::Surface::APIAttachment

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

Constructor & Destructor Documentation

virtual kanzi::Surface::~Surface ( )

virtual

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

explicitprotected

Member Function Documentation

virtual bool kanzi::Surface::isRenderable	(	unsigned int	face,
		unsigned int	mipLevel
	)		const

pure virtual

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

GraphicsFormat kanzi::Surface::getFormat ( ) const

Get GraphicsFormat of Surface.

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

Get number multisample samples. 0 means multisampling is disabled.

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

Get width in pixels.

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

Get height in pixels.

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

Get number of slices.

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

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

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

Get number of mipmap levels.

bool kanzi::Surface::isWellFormed ( ) const

Return true if Surface is valid shape and format.

virtual void kanzi::Surface::attach	(	Framebuffer &	framebuffer,
		APIAttachment	apiAttachment,
		unsigned int	face,
		unsigned int	mipLevel
	)

pure virtual

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

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

protected

virtual void kanzi::Surface::deployOverride ( )

protectedvirtual

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

Reimplemented from kanzi::GPUResource.

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

virtual void kanzi::Surface::freeCommonData ( )

protectedvirtual

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

Reimplemented from kanzi::GPUResource.

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

void kanzi::Surface::configure	(	GraphicsFormat	format,
		unsigned int	sampleCount,
		unsigned int	width,
		unsigned int	height,
		unsigned int	sliceCount,
		unsigned int	faceCount,
		unsigned int	mipLevelCount
	)

protected

Set format and shape for the Surface.

Parameters

format	Format for the Surface
sampleCount

void kanzi::Surface::setFaceCount ( unsigned int value )

protected

void kanzi::Surface::setSliceCount ( unsigned int value )

protected

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

kanzi/graphics_3d/surface.hpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation