kanzi::GlGraphicsOutput Class Reference

GlGraphicsOutput class. More...

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

Inheritance diagram for kanzi::GlGraphicsOutput:
kanzi::GraphicsOutput

Public Member Functions

 GlGraphicsOutput (const struct KzsSurfaceProperties *surfaceProperties, const NativeWindowProperties *windowProperties, const NativeDesktopProperties *desktopProperties)
 Constructor. More...
 
 GlGraphicsOutput (NativeWindowHandle handle, const struct KzsSurfaceProperties *surfaceProperties, const NativeWindowProperties *windowProperties, const NativeDesktopProperties *desktopProperties)
 Constructor. More...
 
virtual ~GlGraphicsOutput () KZ_OVERRIDE
 Destructor. More...
 
virtual void present () KZ_OVERRIDE
 Posts rendering results. More...
 
void setSwapInterval (int interval)
 Sets the swap interval of the underlying graphics implementation. More...
 
virtual void handleEvents (const struct KzsEventQueue *eventQueue) KZ_OVERRIDE
 Handles the window resize event. More...
 
void logProperties () const
 Logs the properties of the graphics output. More...
 
void logExtensions () const
 Logs the extensions of the graphics context. More...
 
void setWindowTitle (const string &title)
 Sets the window title, if possible. More...
 
struct KzsDesktopgetDesktop () const
 
struct KzsWindowgetWindow () const
 
struct KzsSurfacegetSurface () const
 
struct KzsDisplaygetDisplay (size_t index) const
 Access display by index. More...
 
KzsGraphicsContextAPI getGraphicsContextAPI () const
 
void replaceNativeWindow (NativeWindowHandle handle)
 Replaces the native window associated to the graphics output. More...
 
void deleteNativeWindow ()
 Removes the native window associated to the graphics output. More...
 
void * getContextHandle () const
 Gets the handle of the GL context associated to the graphics output. More...
 
void * getDisplayHandle () const
 Gets the handle of display associated to the the graphics output. More...
 
- Public Member Functions inherited from kanzi::GraphicsOutput
 GraphicsOutput ()
 Constructor. More...
 
virtual ~GraphicsOutput ()
 Destructor. More...
 
unsigned int getWidth () const
 Returns the width of rendering area in pixels. More...
 
unsigned int getHeight () const
 Returns the height of rendering area in pixels. More...
 
enum KzsDisplayOrientationAngle getOrientationAngle () const
 Returns the orientations of the rendering area. More...
 
void resize (unsigned int width, unsigned int height)
 Resizes the rendering area. More...
 

Protected Member Functions

virtual void resizeOverride (unsigned int width, unsigned int height) KZ_OVERRIDE
 Resizes the rendering area. More...
 
- 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 implementation that provides basic GL rendering output.

Constructor & Destructor Documentation

kanzi::GlGraphicsOutput::GlGraphicsOutput ( const struct KzsSurfaceProperties surfaceProperties,
const NativeWindowProperties windowProperties,
const NativeDesktopProperties desktopProperties 
)
explicit

Constructor.

kanzi::GlGraphicsOutput::GlGraphicsOutput ( NativeWindowHandle  handle,
const struct KzsSurfaceProperties surfaceProperties,
const NativeWindowProperties windowProperties,
const NativeDesktopProperties desktopProperties 
)
explicit

Constructor.

virtual kanzi::GlGraphicsOutput::~GlGraphicsOutput ( )
virtual

Destructor.

Member Function Documentation

virtual void kanzi::GlGraphicsOutput::present ( )
virtual

Posts rendering results.

Implicitly flushes the rendering pipeline and executes all received rendering commands before posting. setSwapInterval().

Implements kanzi::GraphicsOutput.

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

Sets the swap interval of the underlying graphics implementation.

Parameters
intervalSpecifies the minimum number of video frame periods per buffer swap. Negative interval values are reserved for platform-specific special cases. swapBuffers().
virtual void kanzi::GlGraphicsOutput::handleEvents ( const struct KzsEventQueue *  eventQueue)
virtual

Handles the window resize event.

Implements kanzi::GraphicsOutput.

void kanzi::GlGraphicsOutput::logProperties ( ) const

Logs the properties of the graphics output.

void kanzi::GlGraphicsOutput::logExtensions ( ) const

Logs the extensions of the graphics context.

void kanzi::GlGraphicsOutput::setWindowTitle ( const string &  title)

Sets the window title, if possible.

struct KzsDesktop* kanzi::GlGraphicsOutput::getDesktop ( ) const
struct KzsWindow* kanzi::GlGraphicsOutput::getWindow ( ) const
struct KzsSurface* kanzi::GlGraphicsOutput::getSurface ( ) const
struct KzsDisplay* kanzi::GlGraphicsOutput::getDisplay ( size_t  index) const

Access display by index.

Parameters
indexDisplay index to access.
Returns
Display at given index or 0.
KzsGraphicsContextAPI kanzi::GlGraphicsOutput::getGraphicsContextAPI ( ) const
void kanzi::GlGraphicsOutput::replaceNativeWindow ( NativeWindowHandle  handle)

Replaces the native window associated to the graphics output.

Parameters
handleHandle to the native window.
void kanzi::GlGraphicsOutput::deleteNativeWindow ( )

Removes the native window associated to the graphics output.

Leaves the graphics output to unusable state. This function is only needed when a native window is lost temporarily and will be replaced later.

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

Gets the handle of the GL context associated to the graphics output.

Returns
The handle of associated graphics context object.
void* kanzi::GlGraphicsOutput::getDisplayHandle ( ) const

Gets the handle of display associated to the the graphics output.

Returns
The handle of display associated to the graphics output.
virtual void kanzi::GlGraphicsOutput::resizeOverride ( unsigned int  width,
unsigned int  height 
)
protectedvirtual

Resizes the rendering area.

Reimplemented from kanzi::GraphicsOutput.


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