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

Size information for DCSM canvas size change. More...

#include <DcsmApiTypes.h>

Public Member Functions

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

Public Attributes

uint32_t width
 canvas width in pixels More...
 
uint32_t height
 canvas height in pixels More...
 

Detailed Description

Size information for DCSM canvas size change.

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

Constructor & Destructor Documentation

◆ SizeInfo()

constexpr ramses::SizeInfo::SizeInfo ( uint32_t  w,
uint32_t  h 
)
inlineconstexpr

Constructor requiring size to be specified explicitly.

Parameters
[in]wWidth
[in]hHeight

Member Function Documentation

◆ operator!=()

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

The inequality comparison operator.

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

◆ operator==()

constexpr bool ramses::SizeInfo::operator== ( const SizeInfo 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::SizeInfo::height

canvas height in pixels

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

◆ width

uint32_t ramses::SizeInfo::width

canvas width in pixels

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

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