RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Public Member Functions | Public Attributes | List of all members
ramses::Rect Struct Reference

Rectangle consisting of x, y, width, height. More...

#include <DcsmApiTypes.h>

Public Member Functions

constexpr Rect (uint32_t xpos, uint32_t ypos, uint32_t w, uint32_t h)
 Constructor requiring values to be specified explicitly. More...
 
constexpr bool operator== (const Rect &rhs) const
 The equality comparison operator. More...
 
constexpr bool operator!= (const Rect &rhs) const
 The inequality comparison operator. More...
 

Public Attributes

uint32_t x
 x position of rectangle More...
 
uint32_t y
 y position of rectangle More...
 
uint32_t width
 width of rectangle More...
 
uint32_t height
 height of rectangle More...
 

Detailed Description

Rectangle consisting of x, y, width, height.

Constructor & Destructor Documentation

◆ Rect()

constexpr ramses::Rect::Rect ( uint32_t  xpos,
uint32_t  ypos,
uint32_t  w,
uint32_t  h 
)
inlineconstexpr

Constructor requiring values to be specified explicitly.

Parameters
[in]xposx position
[in]yposy position
[in]wWidth
[in]hHeight

Member Function Documentation

◆ operator!=()

constexpr bool ramses::Rect::operator!= ( const Rect rhs) const
inlineconstexpr

The inequality comparison operator.

Parameters
rhsThe instance to compare to
Returns
True if not same, false otherwise

◆ operator==()

constexpr bool ramses::Rect::operator== ( const Rect rhs) const
inlineconstexpr

The equality comparison operator.

Parameters
rhsThe instance to compare to
Returns
True if same, false otherwise

Member Data Documentation

◆ height

uint32_t ramses::Rect::height

height of rectangle

Examples
ramses-example-dcsm-provider/src/main.cpp.

◆ width

uint32_t ramses::Rect::width

width of rectangle

Examples
ramses-example-dcsm-provider/src/main.cpp.

◆ x

uint32_t ramses::Rect::x

x position of rectangle

◆ y

uint32_t ramses::Rect::y

y position of rectangle


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