REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
Type | ObjectType () const |
WindowInfoControl & | operator= (WindowInfoControl &&in_that) |
WindowInfoControl & | operator= (WindowInfoControl const &in_that) |
bool | ShowPhysicalPixels (unsigned int &out_width, unsigned int &out_height) const |
bool | ShowPhysicalSize (float &out_width, float &out_height) const |
bool | ShowPixelAspectRatio (float &out_pixel_aspect) const |
bool | ShowResolution (float &out_horizontal, float &out_vertical) const |
bool | ShowWindowAspectRatio (float &out_window_aspect) const |
bool | ShowWindowPixels (unsigned int &out_width, unsigned int &out_height) const |
bool | ShowWindowSize (float &out_width, float &out_height) const |
WindowInfoControl (WindowKey &in_window) | |
WindowInfoControl (WindowInfoControl const &in_that) | |
WindowInfoControl (WindowInfoControl &&in_that) | |
~WindowInfoControl () | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The WindowInfoControl class is a smart pointer that is tied to a database object. This object allows you to query various attributes about a window, such as its size and aspect ratio.
|
explicit |
Initializes a control tied to the window segment in_window.
WindowInfoControl::WindowInfoControl | ( | WindowInfoControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
WindowInfoControl::WindowInfoControl | ( | WindowInfoControl && | in_that | ) |
The move constructor creates a WindowInfoControl by transferring the underlying impl of the rvalue reference to this WindowInfoControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a WindowInfoControl to take the impl from. |
WindowInfoControl::~WindowInfoControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Control.
WindowInfoControl& WindowInfoControl::operator= | ( | WindowInfoControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this WindowInfoControl thereby avoiding a copy.
in_that | An rvalue reference to a WindowInfoControl to take the impl from. |
WindowInfoControl& WindowInfoControl::operator= | ( | WindowInfoControl const & | in_that | ) |
Share the smart-pointer.
bool WindowInfoControl::ShowPhysicalPixels | ( | unsigned int & | out_width, |
unsigned int & | out_height | ||
) | const |
Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
out_width | The width of the physical display in pixels. |
out_height | The height of the physical display in pixels. |
bool WindowInfoControl::ShowPhysicalSize | ( | float & | out_width, |
float & | out_height | ||
) | const |
Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
out_width | The width of the physical display in centimeters. |
out_height | The height of the physical display in centimeters. |
bool WindowInfoControl::ShowPixelAspectRatio | ( | float & | out_pixel_aspect | ) | const |
Shows the aspect ratio of the window's pixels. This is computed as the horizontal resolution divided by the vertical resolution.
out_pixel_aspect | The aspect ratio of the window defined as width / height in pixels. |
bool WindowInfoControl::ShowResolution | ( | float & | out_horizontal, |
float & | out_vertical | ||
) | const |
Shows both the horizontal and vertical resolution of the window. Resolution is computed as pixels per centimeter. If the size or the pixels are not set, this function will return false.
out_horizontal | The horizontal resolution of the window. |
out_vertical | The vertical resolution of the window. |
bool WindowInfoControl::ShowWindowAspectRatio | ( | float & | out_window_aspect | ) | const |
Shows the aspect ratio of the window. Aspect ratio is computed as width / height in centimeters.
out_window_aspect | The aspect ratio of the window defined as width / height in centimeters. |
bool WindowInfoControl::ShowWindowPixels | ( | unsigned int & | out_width, |
unsigned int & | out_height | ||
) | const |
Shows the number of pixels in the window.
out_width | The width of the window in pixels. |
out_height | The height of the window in pixels. |
bool WindowInfoControl::ShowWindowSize | ( | float & | out_width, |
float & | out_height | ||
) | const |
Shows the size, in centimeters, of the window.
out_width | The width of the window in centimeters. |
out_height | The height of the window in centimeters. |