AeonGUI
A portable video game graphic user interface library.
Loading...
Searching...
No Matches
AeonGUI::Rect Class Reference

Rectangle class. More...

#include <aeongui/Rect.hpp>

Public Member Functions

 Rect (int32_t aX=0, int32_t aY=0, uint32_t aWidth=0, uint32_t aHeight=0)
 Position and Dimensions constructor.
Getters
int32_t GetX () const
 Get X coordinate.
int32_t GetY () const
 Get X coordinate.
uint32_t GetWidth () const
 Get Width.
uint32_t GetHeight () const
 Get Height.

Setters

Get rect position.

Parameters
x[out] Reference to a variable to hold the X coordinate.
y[out] Reference to a variable to hold the Y coordinate.

Get rect Dimensions.

Parameters
width[out] Reference to a variable to hold the rect's width.
height[out] Reference to a variable to hold the rect's height.
void SetX (int32_t X)
 Set X coordinate.
void SetY (int32_t Y)
 Set Y coordinate.
void SetWidth (uint32_t width)
 Set Width.
void SetHeight (uint32_t height)
 Set Height.

Detailed Description

Rectangle class.

Constructor & Destructor Documentation

◆ Rect()

AeonGUI::Rect::Rect ( int32_t aX = 0,
int32_t aY = 0,
uint32_t aWidth = 0,
uint32_t aHeight = 0 )

Position and Dimensions constructor.

Parameters
aXX Position.
aYY Position.
aWidthRectangle Width.
aHeightRectangle Height.

Member Function Documentation

◆ GetHeight()

uint32_t AeonGUI::Rect::GetHeight ( ) const

Get Height.

Returns
The height of the rect.

◆ GetWidth()

uint32_t AeonGUI::Rect::GetWidth ( ) const

Get Width.

Returns
The width of the rect.

◆ GetX()

int32_t AeonGUI::Rect::GetX ( ) const

Get X coordinate.

Returns
Value of the rect's X coordinate.

◆ GetY()

int32_t AeonGUI::Rect::GetY ( ) const

Get X coordinate.

Returns
Value of the rect's X coordinate.

◆ SetHeight()

void AeonGUI::Rect::SetHeight ( uint32_t height)

Set Height.

Parameters
heightThe new height.

◆ SetWidth()

void AeonGUI::Rect::SetWidth ( uint32_t width)

Set Width.

Parameters
widthThe new width.

◆ SetX()

void AeonGUI::Rect::SetX ( int32_t X)

Set X coordinate.

Parameters
XValue to set the X coordinate of the rect to.

◆ SetY()

void AeonGUI::Rect::SetY ( int32_t Y)

Set Y coordinate.

Parameters
YValue to set the Y coordinate of the rect to.

The documentation for this class was generated from the following files:
  • include/aeongui/Rect.hpp
  • core/Rect.cpp