HPS::WindowInfoControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::WindowInfoControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
WindowInfoControloperator= (WindowInfoControl &&in_that)
 
WindowInfoControloperator= (WindowInfoControl const &in_that)
 
bool ShowColorBitPlanes (size_t &out_planes) const
 
bool ShowDepthBufferSize (size_t &out_bits) const
 
bool ShowDepthPeelingLayers (size_t &out_layers) const
 
bool ShowGPUName (UTF8 &out_name) const
 
bool ShowLastUpdateInfo (UpdateInfo &out_info) const
 
bool ShowLastUpdateTime (Time &out_time) const
 
bool ShowMaxLights (size_t &out_lights) const
 
bool ShowMaxTextureSize (unsigned int &out_width, unsigned int &out_height) const
 
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 ShowVideoMemory (size_t &out_video_memory) 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
 
virtual HPS::Type Type () const
 
 WindowInfoControl (WindowKey &in_window)
 
 WindowInfoControl (WindowInfoControl const &in_that)
 
 WindowInfoControl (WindowInfoControl &&in_that)
 
 ~WindowInfoControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::WindowInfoControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ WindowInfoControl() [1/3]

HPS::WindowInfoControl::WindowInfoControl ( WindowKey in_window)
explicit

Initializes a control tied to the window segment in_window.

◆ WindowInfoControl() [2/3]

HPS::WindowInfoControl::WindowInfoControl ( WindowInfoControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ WindowInfoControl() [3/3]

HPS::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.

Parameters
in_thatAn rvalue reference to a WindowInfoControl to take the impl from.

◆ ~WindowInfoControl()

HPS::WindowInfoControl::~WindowInfoControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::WindowInfoControl::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Control.

◆ operator=() [1/2]

WindowInfoControl& HPS::WindowInfoControl::operator= ( WindowInfoControl &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this WindowInfoControl thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a WindowInfoControl to take the impl from.
Returns
A reference to this WindowInfoControl.

◆ operator=() [2/2]

WindowInfoControl& HPS::WindowInfoControl::operator= ( WindowInfoControl const &  in_that)

Share the underlying smart-pointer of the WindowInfoControl source.

Parameters
in_thatThe WindowInfoControl source of the assignment.
Returns
A reference to this WindowInfoControl.

◆ ShowColorBitPlanes()

bool HPS::WindowInfoControl::ShowColorBitPlanes ( size_t &  out_planes) const

Shows the number of color bit planes present for each pixel in the frame buffer.

Parameters
out_planesThe number of color bit planes present for each pixel in the frame buffer.
Returns
true if the color bit plane count can be queried from the hardware, false otherwise.

◆ ShowDepthBufferSize()

bool HPS::WindowInfoControl::ShowDepthBufferSize ( size_t &  out_bits) const

Shows the number of bits used in this window's depth buffer.

Parameters
out_bitsThe number of bits used in this window's depth buffer.
Returns
true if depth buffer size can be queried from the hardware, false otherwise.

◆ ShowDepthPeelingLayers()

bool HPS::WindowInfoControl::ShowDepthPeelingLayers ( size_t &  out_layers) const

Shows the number of depth peeling layers that are supported for this window associated with this control.

Parameters
out_layersThe number of depth peeling layers that are supported for this window associated with this control.
Returns
true if depth peeling layers can be queried from the hardware, false otherwise.

◆ ShowGPUName()

bool HPS::WindowInfoControl::ShowGPUName ( UTF8 out_name) const

Shows the name of the GPU that is being used to render to this window.

Parameters
out_nameThe name of the GPU.
Returns
true if the name can be queried from the hardware, false otherwise.

◆ ShowLastUpdateInfo()

bool HPS::WindowInfoControl::ShowLastUpdateInfo ( UpdateInfo out_info) const

Shows information pertaining to the last performed update.

Parameters
out_infoThe information pertaining to the last performed update.
Returns
false if called before the initial update, true otherwise.

◆ ShowLastUpdateTime()

bool HPS::WindowInfoControl::ShowLastUpdateTime ( Time &  out_time) const

Shows the time taken (in milliseconds) to complete the last update. This function is limited to the resolution of the system timer. In practice, that means that frame rates above 20 per second cannot be accurately measured in this manner.

Parameters
out_timeThe time taken (in milliseconds) to complete the last update.
Returns
false if called before the initial update, true otherwise.

◆ ShowMaxLights()

bool HPS::WindowInfoControl::ShowMaxLights ( size_t &  out_lights) const

Shows the maximum number of lights that can be used within the window associated with this control.

Parameters
out_lightsThe maximum number of lights that can be used within the window associated with this control.
Returns
true if the maximum light count can be queried from the hardware, false otherwise.

◆ ShowMaxTextureSize()

bool HPS::WindowInfoControl::ShowMaxTextureSize ( unsigned int &  out_width,
unsigned int &  out_height 
) const

Shows the maximum texture size that can be used.

Parameters
out_widthThe maximum texture width that can be used.
out_heightThe maximum texture height that can be used.
Returns
true if the maximum texture size can be queried from the hardware, false otherwise.

◆ ShowPhysicalPixels()

bool HPS::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.).

Parameters
out_widthThe width of the physical display in pixels.
out_heightThe height of the physical display in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowPhysicalSize()

bool HPS::WindowInfoControl::ShowPhysicalSize ( float &  out_width,
float &  out_height 
) const

Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters
out_widthThe width of the physical display in centimeters.
out_heightThe height of the physical display in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ ShowPixelAspectRatio()

bool HPS::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.

Parameters
out_pixel_aspectThe aspect ratio of the window defined as width / height in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowResolution()

bool HPS::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.

Parameters
out_horizontalThe horizontal resolution of the window.
out_verticalThe vertical resolution of the window.
Returns
true if the setting is valid, false otherwise.

◆ ShowVideoMemory()

bool HPS::WindowInfoControl::ShowVideoMemory ( size_t &  out_video_memory) const

Shows the number (in MB) of video memory available on the system.

Parameters
out_video_memoryThe number (in MB) of video memory available on the system.
Returns
true if video memory can be queried from the hardware, false otherwise.

◆ ShowWindowAspectRatio()

bool HPS::WindowInfoControl::ShowWindowAspectRatio ( float &  out_window_aspect) const

Shows the aspect ratio of the window. Aspect ratio is computed as width / height in centimeters.

Parameters
out_window_aspectThe aspect ratio of the window defined as width / height in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowPixels()

bool HPS::WindowInfoControl::ShowWindowPixels ( unsigned int &  out_width,
unsigned int &  out_height 
) const

Shows the number of pixels in the window.

Parameters
out_widthThe width of the window in pixels.
out_heightThe height of the window in pixels.
Returns
true if the setting is valid, false otherwise.

◆ ShowWindowSize()

bool HPS::WindowInfoControl::ShowWindowSize ( float &  out_width,
float &  out_height 
) const

Shows the size, in centimeters, of the window.

Parameters
out_widthThe width of the window in centimeters.
out_heightThe height of the window in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::WindowInfoControl::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.


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