WindowInfoControl

class HPS.WindowInfoControl : public HPS.Control

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.

Public Functions

override void Dispose ()

override HPS.Type ObjectType ()

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

Return

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

bool ShowColorBitPlanes (out ulong out_planes)

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

Param out_planes

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

Return

true if the color bit plane count can be queried from the hardware, false otherwise.

bool ShowDepthBufferSize (out ulong out_bits)

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

Param out_bits

The number of bits used in this window’s depth buffer.

Return

true if depth buffer size can be queried from the hardware, false otherwise.

bool ShowDepthPeelingLayers (out ulong out_layers)

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

Param out_layers

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

Return

true if depth peeling layers can be queried from the hardware, false otherwise.

bool ShowGPUName (out string out_name)

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

Param out_name

The name of the GPU.

Return

true if the name can be queried from the hardware, false otherwise.

bool ShowLastUpdateInfo (out HPS.UpdateInfo out_info)

Shows information pertaining to the last performed update.

Param out_info

The information pertaining to the last performed update.

Return

false if called before the initial update, true otherwise.

bool ShowLastUpdateTime (out double out_time)

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.

Param out_time

The time taken (in milliseconds) to complete the last update.

Return

false if called before the initial update, true otherwise.

bool ShowMaxLights (out ulong out_lights)

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

Param out_lights

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

Return

true if the maximum light count can be queried from the hardware, false otherwise.

bool ShowMaxTextureSize (out uint out_width, out uint out_height)

Shows the maximum texture size that can be used.

Param out_width

The maximum texture width that can be used.

Param out_height

The maximum texture height that can be used.

Return

true if the maximum texture size can be queried from the hardware, false otherwise.

bool ShowPhysicalPixels (out uint out_width, out uint out_height)

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

Param out_width

The width of the physical display in pixels.

Param out_height

The height of the physical display in pixels.

Return

true if the setting is valid, false otherwise.

bool ShowPhysicalSize (out float out_width, out float out_height)

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

Param out_width

The width of the physical display in centimeters.

Param out_height

The height of the physical display in centimeters.

Return

true if the setting is valid, false otherwise.

bool ShowPixelAspectRatio (out float out_pixel_aspect)

Shows the aspect ratio of the window’s pixels. This is computed as the horizontal resolution divided by the vertical resolution.

Param out_pixel_aspect

The aspect ratio of the window defined as width / height in pixels.

Return

true if the setting is valid, false otherwise.

bool ShowResolution (out float out_horizontal, out float out_vertical)

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.

Param out_horizontal

The horizontal resolution of the window.

Param out_vertical

The vertical resolution of the window.

Return

true if the setting is valid, false otherwise.

bool ShowVideoMemory (out ulong out_video_memory)

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

Param out_video_memory

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

Return

true if video memory can be queried from the hardware, false otherwise.

bool ShowWindowAspectRatio (out float out_window_aspect)

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

Param out_window_aspect

The aspect ratio of the window defined as width / height in centimeters.

Return

true if the setting is valid, false otherwise.

bool ShowWindowPixels (out uint out_width, out uint out_height)

Shows the number of pixels in the window.

Param out_width

The width of the window in pixels.

Param out_height

The height of the window in pixels.

Return

true if the setting is valid, false otherwise.

bool ShowWindowSize (out float out_width, out float out_height)

Shows the size, in centimeters, of the window.

Param out_width

The width of the window in centimeters.

Param out_height

The height of the window in centimeters.

Return

true if the setting is valid, false otherwise.

WindowInfoControl (HPS.WindowInfoControl in_that)

Initializes a control tied to the same object as in_that.

WindowInfoControl (HPS.WindowKey in_window)

Initializes a control tied to the window segment in_window.