Kanzi Engine API
kanzi::GlGraphicsOutput Class Referenceabstract

GlGraphicsOutput class. More...

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

Inheritance diagram for kanzi::GlGraphicsOutput:
[legend]

Public Member Functions

virtual void activate ()=0
 Makes the graphics output active for the current thread. More...
 
virtual void * createImage (void *context, int target, void *data, int *attributes)=0
 Function for creating native image object, which can be shared between client APIs. More...
 
virtual void destroyImage (void *image)=0
 Function for destroying native image object. More...
 
virtual SurfaceColorSpace getColorSpace () const =0
 Gets the color space used by the associated graphics context. More...
 
virtual void * getContextHandle () const =0
 Gets the handle of associated graphics context object. More...
 
virtual void * getDisplayHandle () const =0
 Gets the handle of display associated to the graphics output. More...
 
virtual KzsGraphicsContextAPI getGraphicsContextAPI () const =0
 Gets the API used by the associated graphics context. More...
 
virtual kzsGLProcPointer getProcAddress (string_view functionName)=0
 Gets pointer to graphics API function. More...
 
virtual KzsSurfaceType getSurfaceType () const =0
 Gets the type of the associated graphics surface. More...
 
 GlGraphicsOutput ()
 Constructor. More...
 
virtual void logExtensions () const =0
 Logs the extensions of the graphics context. More...
 
virtual void logProperties () const =0
 Logs the properties of the graphics output. More...
 
virtual void setSwapInterval (int interval)=0
 Sets the swap interval of the associated graphics implementation. More...
 
 ~GlGraphicsOutput () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::GraphicsOutput
unsigned int getHeight () const
 Returns the height of the rendering area. More...
 
enum KzsDisplayOrientationAngle getOrientationAngle () const
 Returns the orientations of the rendering area. More...
 
unsigned int getWidth () const
 Returns the width of the rendering area. More...
 
 GraphicsOutput ()
 Constructor. More...
 
virtual void handleEvents (EventQueue &eventQueue)=0
 Handles appropriate events. More...
 
virtual void present ()=0
 Posts rendering results. More...
 
virtual ~GraphicsOutput ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from kanzi::GraphicsOutput
void updateSize (unsigned int width, unsigned int height)
 Updates the rendering area size. More...
 

Detailed Description

GlGraphicsOutput class.

A graphics output interface defining basic functionality used by the GL renderer.

Constructor & Destructor Documentation

kanzi::GlGraphicsOutput::GlGraphicsOutput ( )
inlineexplicit

Constructor.

kanzi::GlGraphicsOutput::~GlGraphicsOutput ( )
inlineoverride

Destructor.

Member Function Documentation

virtual KzsGraphicsContextAPI kanzi::GlGraphicsOutput::getGraphicsContextAPI ( ) const
pure virtual

Gets the API used by the associated graphics context.

Returns
Graphics context API.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual KzsSurfaceType kanzi::GlGraphicsOutput::getSurfaceType ( ) const
pure virtual

Gets the type of the associated graphics surface.

Returns
Surface type.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual SurfaceColorSpace kanzi::GlGraphicsOutput::getColorSpace ( ) const
pure virtual

Gets the color space used by the associated graphics context.

Returns
Color Space

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual kzsGLProcPointer kanzi::GlGraphicsOutput::getProcAddress ( string_view  functionName)
pure virtual

Gets pointer to graphics API function.

Parameters
functionNameName of the function.
Returns
Pointer to the function, or null if not found.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::GlGraphicsOutput::activate ( )
pure virtual

Makes the graphics output active for the current thread.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::GlGraphicsOutput::setSwapInterval ( int  interval)
pure virtual

Sets the swap interval of the associated graphics implementation.

Parameters
intervalSpecifies the minimum number of video frame periods per buffer swap. Negative interval values are reserved for platform-specific special cases.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void* kanzi::GlGraphicsOutput::getContextHandle ( ) const
pure virtual

Gets the handle of associated graphics context object.

Returns
The handle of associated graphics context object.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void* kanzi::GlGraphicsOutput::createImage ( void *  context,
int  target,
void *  data,
int *  attributes 
)
pure virtual

Function for creating native image object, which can be shared between client APIs.

Parameters
contextContext to create the image for.
targetContext-specific target specifier.
dataData to use as image contents.
attributesContext-specific attributes list.
Returns
Returns created image, or null on error.
See also
getContextHandle().

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::GlGraphicsOutput::destroyImage ( void *  image)
pure virtual

Function for destroying native image object.

Parameters
imageImage to destroy.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::GlGraphicsOutput::logProperties ( ) const
pure virtual

Logs the properties of the graphics output.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::GlGraphicsOutput::logExtensions ( ) const
pure virtual

Logs the extensions of the graphics context.

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void* kanzi::GlGraphicsOutput::getDisplayHandle ( ) const
pure virtual

Gets the handle of display associated to the graphics output.

Returns
The handle of display associated to the graphics output.

Implemented in kanzi::DefaultGlGraphicsOutput.


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