KarmaEngine
Game Engine for practical learning and research purposes
Loading...
Searching...
No Matches
KarmaGuiViewport Struct Reference

A Platform Window (always 1 unless multi-viewport are enabled. One per platform window to output to). In the future, may represent Platform Monitor. More...

#include <KarmaGui.h>

Inheritance diagram for KarmaGuiViewport:
KGGuiViewportP

Public Member Functions

KGVec2 GetCenter () const
KGVec2 GetWorkCenter () const

Public Attributes

KGGuiID ID
KarmaGuiViewportFlags Flags
KGVec2 Pos
KGVec2 Size
KGVec2 WorkPos
KGVec2 WorkSize
float DpiScale
KGGuiID ParentViewportId
KGDrawDataDrawData
void * RendererUserData
void * PlatformUserData
void * PlatformHandle
void * PlatformHandleRaw
bool PlatformWindowCreated
bool PlatformRequestMove
bool PlatformRequestResize
bool PlatformRequestClose

Detailed Description

A Platform Window (always 1 unless multi-viewport are enabled. One per platform window to output to). In the future, may represent Platform Monitor.

Currently represents the Platform Window created by the application which is hosting our KarmaGui windows. With multi-viewport enabled, we extend this concept to have multiple active viewports.

In the future we will extend this concept further to also represent Platform Monitor and support a "no main platform window" operation mode. About Main Area vs Work Area:

  • Main Area = entire viewport.
  • Work Area = entire viewport minus sections used by main menu bars (for platform windows), or by task bar (for platform monitor).
  • Windows are generally trying to stay within the Work Area of their host viewport.
Since
Karma 1.0.0

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