kanzi::Framebuffer Class Reference

Framebuffer allows the rendering to the user-specified texture or renderbuffer, instead of rendering directly to the window. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/framebuffer.hpp>

Inheritance diagram for kanzi::Framebuffer:
kanzi::GPUResource kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

struct  Attachment
 Framebuffer attachment settings. More...
 
struct  CreateInfo
 Framebuffer creation parameters. More...
 

Public Types

enum  AttachmentPoint {
  AttachmentPointColor0, AttachmentPointColor1, AttachmentPointColor2, AttachmentPointColor3,
  AttachmentPointDepthStencil, AttachmentPointCount
}
 
enum  AttachmentBit {
  AttachmentBitColor0, AttachmentBitColor1, AttachmentBitColor2, AttachmentBitColor3,
  AttachmentBitDepthStencil
}
 
enum  Target { TargetReadAndDraw, TargetRead, TargetDraw }
 Framebuffer target selects draw or read framebuffer, or both. More...
 
- 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 intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

 Framebuffer (Domain *domain, const CreateInfo &createInfo, string_view name)
 
SurfaceSharedPtr getAttachment (AttachmentPoint attachment) const
 Returns the attachment from the framebuffer for the specified attachment point. More...
 
TextureSharedPtr getTexture (AttachmentPoint attachment) const
 Returns the attachment as texture from the framebuffer. More...
 
unsigned int getCommonWidth () const
 Returns the common width of the framebuffer. More...
 
unsigned int getCommonHeight () const
 Returns the common height of the framebuffer. More...
 
unsigned int getCommonSampleCount () const
 Returns the common sample count of the framebuffer. More...
 
Surface::Usage getUsage () const
 Returns Framebuffer usage. More...
 
unsigned int getNativeHandle () const
 Returns the GL API object handle for the framebuffer. More...
 
virtual void loadFromKZB (const KzuResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
 Function for loading the resource from .KZB. More...
 
bool hasAttachment (AttachmentPoint attachmentPoint) const
 Tell if framebuffer has given attachment. More...
 
- Public Member Functions inherited from kanzi::GPUResource
virtual ~GPUResource () KZ_OVERRIDE
 
void invalidate ()
 Notify resource that graphics context was lost and all GPU resources are invalid. More...
 
unsigned int getGPUMemoryUsage () const
 
RenderergetRenderer () const
 
bool isDeployed () const
 
- Public Member Functions inherited from kanzi::Resource
KzcMemoryManagergetMemoryManager () const
 
 Resource (Domain *domain, string_view name)
 
virtual ~Resource ()
 
virtual void unloadOverride ()
 Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...
 
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
void setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
 Set the binary directory and path of the resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
void setNotLoaded ()
 
bool isFromKZB () const
 
void reload ()
 
void reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void reloadFromFile (string_view filePath)
 
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...
 
bool isKeepAlive () 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 ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntryapplyObjectStyle (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...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
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. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
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
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static FramebufferSharedPtr create (Domain *domain, const CreateInfo &createInfo, string_view name)
 Creates the framebuffer from specified attachments. More...
 
static FramebufferSharedPtr create (Domain *domain, const CreateInfo &createInfo)
 Creates the framebuffer from specified attachments. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

virtual void invalidateOverride () KZ_OVERRIDE
 Notify resource that graphics context was lost and all GPU resources are invalid. Called by invalidate() More...
 
virtual bool isDeployedOverride () const KZ_OVERRIDE
 
virtual void reloadOverride () KZ_OVERRIDE
 Resource::reloadOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::GPUResource
 GPUResource (Domain *domain, string_view name="")
 
virtual unsigned int getGPUMemoryUsageOverride () const
 
- Protected Member Functions inherited from kanzi::Resource
virtual void reloadFromKzbOverride (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual unsigned int getCPUMemoryUsageOverride () const
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &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...
 

Detailed Description

Framebuffer allows the rendering to the user-specified texture or renderbuffer, instead of rendering directly to the window.

Framebuffer must have at least one Surface (Texture or Renderbuffer) attached to it. Depth and stencil tests require that a Surface (typically Renderbuffer) is attached to the depth and stencil attachment point.

Member Enumeration Documentation

Enumerator
AttachmentPointColor0 

Color buffer 0 framebuffer attachment point (OpenGL ES 2 compatible)

AttachmentPointColor1 

Color buffer 1 framebuffer attachment point (Requires OpenGL ES 3)

AttachmentPointColor2 

Color buffer 2 framebuffer attachment point (Requires OpenGL ES 3)

AttachmentPointColor3 

Color buffer 3 framebuffer attachment point (Requires OpenGL ES 3)

AttachmentPointDepthStencil 

Depth and stencil framebuffer attachment point.

AttachmentPointCount 

Number of attachment points in Framebuffer.

Enumerator
AttachmentBitColor0 
AttachmentBitColor1 
AttachmentBitColor2 
AttachmentBitColor3 
AttachmentBitDepthStencil 

Framebuffer target selects draw or read framebuffer, or both.

Enumerator
TargetReadAndDraw 

Both read and draw framebuffers.

TargetRead 

Read framebuffe.

TargetDraw 

Draw framebuffer.

Constructor & Destructor Documentation

kanzi::Framebuffer::Framebuffer ( Domain domain,
const CreateInfo createInfo,
string_view  name 
)
explicit

Member Function Documentation

static FramebufferSharedPtr kanzi::Framebuffer::create ( Domain domain,
const CreateInfo createInfo,
string_view  name 
)
static

Creates the framebuffer from specified attachments.

The framebuffer is deployed and ready to use.

Parameters
domainDomain for the graphics resource
createInfoWidth of the framebuffer
nameName
Returns
The created framebuffer
static FramebufferSharedPtr kanzi::Framebuffer::create ( Domain domain,
const CreateInfo createInfo 
)
static

Creates the framebuffer from specified attachments.

The framebuffer is deployed and ready to use.

Parameters
domainDomain for the graphics resource
createInfoWidth of the framebuffer
Returns
The created framebuffer
SurfaceSharedPtr kanzi::Framebuffer::getAttachment ( AttachmentPoint  attachment) const

Returns the attachment from the framebuffer for the specified attachment point.

Parameters
attachmentAttachment point to examine
Returns
The attachment for the specified attachment point in the framebuffer
TextureSharedPtr kanzi::Framebuffer::getTexture ( AttachmentPoint  attachment) const

Returns the attachment as texture from the framebuffer.

Parameters
attachmentAttachment point to query from the framebuffer. For OpenGL ES 2, either Framebuffer::AttachmentColor0 or Framebuffer::AttachmentDepthStencil.
Returns
Texture attached to the specified attachment point, or empty if there is no texture.
unsigned int kanzi::Framebuffer::getCommonWidth ( ) const

Returns the common width of the framebuffer.

Returns
The width of the framebuffer in pixels
unsigned int kanzi::Framebuffer::getCommonHeight ( ) const

Returns the common height of the framebuffer.

Returns
The height of the framebuffer in pixels
unsigned int kanzi::Framebuffer::getCommonSampleCount ( ) const

Returns the common sample count of the framebuffer.

Returns
The number of multisample samples in the framebuffer. In OpenGL ES 2 this is zero.
Surface::Usage kanzi::Framebuffer::getUsage ( ) const

Returns Framebuffer usage.

Returns
Usage for framebuffer.
unsigned int kanzi::Framebuffer::getNativeHandle ( ) const

Returns the GL API object handle for the framebuffer.

Returns
GL API framebuffer object handle
virtual void kanzi::Framebuffer::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.

bool kanzi::Framebuffer::hasAttachment ( AttachmentPoint  attachmentPoint) const
inline

Tell if framebuffer has given attachment.

Parameters
attachmentAttachment to check for.
Returns
True if yes, false if no.
virtual void kanzi::Framebuffer::invalidateOverride ( )
protectedvirtual

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

Reimplemented from kanzi::GPUResource.

virtual bool kanzi::Framebuffer::isDeployedOverride ( ) const
protectedvirtual

Implements kanzi::GPUResource.

virtual void kanzi::Framebuffer::reloadOverride ( )
protectedvirtual

Resource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.


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