HPS.WindowInfoControl Class Reference
Inheritance diagram for HPS.WindowInfoControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
bool ShowColorBitPlanes (out ulong out_planes)
 
bool ShowDepthBufferSize (out ulong out_bits)
 
bool ShowDepthPeelingLayers (out ulong out_layers)
 
bool ShowGPUName (out string out_name)
 
bool ShowLastUpdateInfo (out HPS.UpdateInfo out_info)
 
bool ShowLastUpdateTime (out double out_time)
 
bool ShowMaxLights (out ulong out_lights)
 
bool ShowMaxTextureSize (out uint out_width, out uint out_height)
 
bool ShowPhysicalPixels (out uint out_width, out uint out_height)
 
bool ShowPhysicalSize (out float out_width, out float out_height)
 
bool ShowPixelAspectRatio (out float out_pixel_aspect)
 
bool ShowResolution (out float out_horizontal, out float out_vertical)
 
bool ShowVideoMemory (out ulong out_video_memory)
 
bool ShowWindowAspectRatio (out float out_window_aspect)
 
bool ShowWindowPixels (out uint out_width, out uint out_height)
 
bool ShowWindowSize (out float out_width, out float out_height)
 
override HPS.Type Type ()
 
 WindowInfoControl (HPS.WindowKey in_window)
 
 WindowInfoControl (HPS.WindowInfoControl in_that)
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.WindowInfoControl.WindowInfoControl ( HPS.WindowKey  in_window)
inline

Initializes a control tied to the window segment in_window.

◆ WindowInfoControl() [2/2]

HPS.WindowInfoControl.WindowInfoControl ( HPS.WindowInfoControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.WindowInfoControl.ObjectType ( )
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.

◆ ShowColorBitPlanes()

bool HPS.WindowInfoControl.ShowColorBitPlanes ( out ulong  out_planes)
inline

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 ( out ulong  out_bits)
inline

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 ( out ulong  out_layers)
inline

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 ( out string  out_name)
inline

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 ( out HPS.UpdateInfo  out_info)
inline

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 ( out double  out_time)
inline

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 ( out ulong  out_lights)
inline

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 ( out uint  out_width,
out uint  out_height 
)
inline

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 ( out uint  out_width,
out uint  out_height 
)
inline

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 ( out float  out_width,
out float  out_height 
)
inline

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 ( out float  out_pixel_aspect)
inline

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 ( out float  out_horizontal,
out float  out_vertical 
)
inline

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 ( out ulong  out_video_memory)
inline

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 ( out float  out_window_aspect)
inline

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 ( out uint  out_width,
out uint  out_height 
)
inline

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 ( out float  out_width,
out float  out_height 
)
inline

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()

override HPS.Type HPS.WindowInfoControl.Type ( )
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:
  • internals/hps_core/source/cs/HPS.WindowInfoControl.cs