kanzi::Surface Class Referenceabstract

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

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

Inheritance diagram for kanzi::Surface:
kanzi::GPUResource kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject kanzi::Renderbuffer kanzi::Texture

Public Types

enum  Usage { UsageRenderTarget, UsageMultisampleResolveBlitDestination }
 
enum  APIAttachment {
  APIAttachmentColor0, APIAttachmentColor1, APIAttachmentColor2, APIAttachmentColor3,
  APIAttachmentDepth, APIAttachmentStencil, APIAttachmentCount, APIAttachmentInvalid
}
 
enum  Face {
  FacePositiveX, FaceNegativeX, FacePositiveY, FaceNegativeY,
  FacePositiveZ, FaceNegativeZ, FaceDefault
}
 Texture face enumeration. 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

void attach (Usage usage, APIAttachment apiAttachment, Face face, unsigned int mipmapLevel)
 Attach surface to framebuffer. More...
 
GraphicsFormat getFormat () const
 Get GraphicsFormat of Surface. More...
 
unsigned int getFeatures () const
 Get features for Surface. More...
 
unsigned int getRenderTargetSampleCount () const
 Get number of multisample samples for Surface. 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 getMipmapLevelCount () const
 Get number of mipmap levels. 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 loadFromKZB (const ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 Function for loading the resource from .KZB. More...
 
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 ResourceLoaderThreadContext *threadContext)
 Private function for kzuResourceLoad() with specified thread context. More...
 
void kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *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...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr 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...
 

Protected Member Functions

 Surface (Domain *domain, string_view name)
 
virtual void attachOverride (Usage usage, APIAttachment apiAttachment, Face face, unsigned int mipmapLevel)=0
 
virtual GraphicsFormat getFormatOverride () const =0
 
virtual unsigned int getFeaturesOverride () const =0
 
virtual unsigned int getRenderTargetSampleCountOverride () const =0
 
virtual unsigned int getWidthOverride () const =0
 
virtual unsigned int getHeightOverride () const =0
 
virtual unsigned int getSliceCountOverride () const =0
 
virtual unsigned int getFaceCountOverride () const =0
 
virtual unsigned int getMipmapLevelCountOverride () const =0
 
- Protected Member Functions inherited from kanzi::GPUResource
virtual bool isDeployedOverride () const =0
 
 GPUResource (Domain *domain, string_view name="")
 
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
virtual void reloadOverride ()
 
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

- 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 Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 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

Enumerator
UsageRenderTarget 

Framebuffer is used for rendering and potentially as multisample resolve source.

UsageMultisampleResolveBlitDestination 

Framebuffer is used as multisample resolve destination.

Enumerator
APIAttachmentColor0 

Color buffer 0 GL attachment (OpenGL ES 2 compatible)

APIAttachmentColor1 

Color buffer 1 GL attachment (Requires OpenGL ES 3)

Color buffer 2 GL attachment (Requires OpenGL ES 3)

APIAttachmentColor2 
APIAttachmentColor3 

Color buffer 3 GL attachment (Requires OpenGL ES 3)

APIAttachmentDepth 

Depth buffer GL attachment.

APIAttachmentStencil 

Stencil buffer GL attachment.

APIAttachmentCount 
APIAttachmentInvalid 

Invalid GL attachment.

Texture face enumeration.

Enumerator
FacePositiveX 

Positive X.

FaceNegativeX 

Negative X.

FacePositiveY 

Positive Y.

FaceNegativeY 

Negative Y.

FacePositiveZ 

Positive Z.

FaceNegativeZ 

Negative Z.

FaceDefault 

Default face, for non-cubemap textures.

Constructor & Destructor Documentation

kanzi::Surface::Surface ( Domain domain,
string_view  name 
)
inlineexplicitprotected

Member Function Documentation

void kanzi::Surface::attach ( Usage  usage,
APIAttachment  apiAttachment,
Face  face,
unsigned int  mipmapLevel 
)

Attach surface to framebuffer.

Parameters
framebufferFramebuffer where Surface will be attached to.
apiAttachmentAttachment point in framebuffer where surface will be attached to.
faceFace of surface to attach. Ignored for non-cubemap texture or non-texture surfaces.
mipmapLevelMipmap level of surface to attach. Ignored for non-texture surfaces.
GraphicsFormat kanzi::Surface::getFormat ( ) const

Get GraphicsFormat of Surface.

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

Get features for Surface.

See also
GraphicsFormatFeature
unsigned int kanzi::Surface::getRenderTargetSampleCount ( ) const

Get number of multisample samples for Surface.

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::getMipmapLevelCount ( ) const

Get number of mipmap levels.

virtual void kanzi::Surface::attachOverride ( Usage  usage,
APIAttachment  apiAttachment,
Face  face,
unsigned int  mipmapLevel 
)
protectedpure virtual

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

virtual GraphicsFormat kanzi::Surface::getFormatOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getFeaturesOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getRenderTargetSampleCountOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getWidthOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getHeightOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getSliceCountOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getFaceCountOverride ( ) const
protectedpure virtual

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

virtual unsigned int kanzi::Surface::getMipmapLevelCountOverride ( ) const
protectedpure virtual

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


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