Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::GraphicsOutput Class Reference

GraphicsOutput class. More...

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

Inheritance diagram for kanzi::GraphicsOutput:
[legend]

Public Member Functions

KZ_NO_DISCARD Vector2 getDpi () const noexcept
 Returns the resolution of the target coordinate system in dots per inch. More...
 
KZ_NO_DISCARD unsigned int getHeight () const noexcept
 Returns the height of layout area in the target coordinate system. More...
 
KZ_NO_DISCARD unsigned int getWidth () const noexcept
 Returns the width of layout area in the target coordinate system. More...
 
virtual ~GraphicsOutput ()=default
 Destructor. More...
 

Protected Member Functions

void updateDpi (Vector2 dpi)
 Updates the target layout area resolution. More...
 
void updateSize (unsigned int width, unsigned int height)
 Updates the target layout area size. More...
 

Detailed Description

GraphicsOutput class.

Interface for graphics outputs. Provides width and height information for layouting.

Constructor & Destructor Documentation

virtual kanzi::GraphicsOutput::~GraphicsOutput ( )
virtualdefault

Destructor.

Member Function Documentation

KZ_NO_DISCARD unsigned int kanzi::GraphicsOutput::getWidth ( ) const
inlinenoexcept

Returns the width of layout area in the target coordinate system.

Returns
Layout area width in pixels.
KZ_NO_DISCARD unsigned int kanzi::GraphicsOutput::getHeight ( ) const
inlinenoexcept

Returns the height of layout area in the target coordinate system.

Returns
Layout area height in pixels.
KZ_NO_DISCARD Vector2 kanzi::GraphicsOutput::getDpi ( ) const
inlinenoexcept

Returns the resolution of the target coordinate system in dots per inch.

Returns
The target resolution vector.
void kanzi::GraphicsOutput::updateSize ( unsigned int  width,
unsigned int  height 
)
inlineprotected

Updates the target layout area size.

Parameters
widthThe layout width in pixels.
heightThe layout height in pixels.
void kanzi::GraphicsOutput::updateDpi ( Vector2  dpi)
inlineprotected

Updates the target layout area resolution.

Parameters
dpiThe layout resolution in dots per inch.

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