Kanzi Engine API
kanzi::WindowedGraphicsOutput Class Referenceabstract

WindowedGraphicsOutput class. More...

#include <kanzi/core.ui/graphics/windowed_graphics_output.hpp>

Inheritance diagram for kanzi::WindowedGraphicsOutput:
[legend]

Public Member Functions

NativeWindowHandle getNativeWindowHandle ()
 Gets the associated window handle. More...
 
void resize (unsigned int width, unsigned int height)
 Resizes the rendering area. More...
 
void setWindowTitle (string_view title)
 Sets the window title, if possible. More...
 
 WindowedGraphicsOutput ()
 Constructor. More...
 
virtual ~WindowedGraphicsOutput ()
 Destructor. More...
 

Protected Member Functions

virtual NativeWindowHandle getNativeWindowHandleOverride ()=0
 Override function for getNativeWindowHandle(). More...
 
virtual void resizeOverride (unsigned int width, unsigned int height)=0
 Override function for resize(). More...
 
virtual void setWindowTitleOverride (string_view title)=0
 Override function for setWindowTitle(). More...
 

Detailed Description

WindowedGraphicsOutput class.

Mixin interface class for graphics outputs that implement window concepts, like resizing.

Constructor & Destructor Documentation

kanzi::WindowedGraphicsOutput::WindowedGraphicsOutput ( )
inlineexplicit

Constructor.

virtual kanzi::WindowedGraphicsOutput::~WindowedGraphicsOutput ( )
inlinevirtual

Destructor.

Member Function Documentation

void kanzi::WindowedGraphicsOutput::resize ( unsigned int  width,
unsigned int  height 
)

Resizes the rendering area.

Parameters
widthNew rendering area width in pixels.
heightNew rendering area height in pixels.
void kanzi::WindowedGraphicsOutput::setWindowTitle ( string_view  title)

Sets the window title, if possible.

Parameters
titleNew window title.
NativeWindowHandle kanzi::WindowedGraphicsOutput::getNativeWindowHandle ( )

Gets the associated window handle.

Returns
Native window handle.
virtual void kanzi::WindowedGraphicsOutput::resizeOverride ( unsigned int  width,
unsigned int  height 
)
protectedpure virtual

Override function for resize().

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual void kanzi::WindowedGraphicsOutput::setWindowTitleOverride ( string_view  title)
protectedpure virtual

Override function for setWindowTitle().

Implemented in kanzi::DefaultGlGraphicsOutput.

virtual NativeWindowHandle kanzi::WindowedGraphicsOutput::getNativeWindowHandleOverride ( )
protectedpure virtual

Override function for getNativeWindowHandle().

Implemented in kanzi::DefaultGlGraphicsOutput.


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