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

Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
bool | ShowColorBitPlanes (out ulong out_planes) |
Shows the number of color bit planes present for each pixel in the frame buffer. More... | |
bool | ShowDepthBufferSize (out ulong out_bits) |
Shows the number of bits used in this window's depth buffer. More... | |
bool | ShowDepthPeelingLayers (out ulong out_layers) |
Shows the number of depth peeling layers that are supported for this window associated with this control. More... | |
bool | ShowLastUpdateInfo (out HPS.UpdateInfo out_info) |
Shows information pertaining to the last performed update. More... | |
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. More... | |
bool | ShowMaxLights (out ulong out_lights) |
Shows the maximum number of lights that can be used within the window associated with this control. More... | |
bool | ShowMaxTextureSize (out uint out_width, out uint out_height) |
Shows the maximum texture size that can be used. More... | |
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.). More... | |
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.). More... | |
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. More... | |
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. More... | |
bool | ShowVideoMemory (out ulong out_video_memory) |
Shows the number (in MB) of video memory available on the system. More... | |
bool | ShowWindowAspectRatio (out float out_window_aspect) |
Shows the aspect ratio of the window. Aspect ratio is computed as width / height in centimeters. More... | |
bool | ShowWindowPixels (out uint out_width, out uint out_height) |
Shows the number of pixels in the window. More... | |
bool | ShowWindowSize (out float out_width, out float out_height) |
Shows the size, in centimeters, of the window. More... | |
override HPS.Type | Type () |
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. More... | |
WindowInfoControl (HPS.WindowKey in_window) | |
Initializes a control tied to the window segment in_window. More... | |
WindowInfoControl (HPS.WindowInfoControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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
|
inline |
Initializes a control tied to the window segment in_window.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
|
inline |
Shows the number of color bit planes present for each pixel in the frame buffer.
- Parameters
-
out_planes The 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.
|
inline |
Shows the number of bits used in this window's depth buffer.
- Parameters
-
out_bits The number of bits used in this window's depth buffer.
- Returns
- true if depth buffer size can be queried from the hardware, false otherwise.
|
inline |
Shows the number of depth peeling layers that are supported for this window associated with this control.
- Parameters
-
out_layers The 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.
|
inline |
Shows information pertaining to the last performed update.
- Parameters
-
out_info The information pertaining to the last performed update.
- Returns
- false if called before the initial update, true otherwise.
|
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_time The time taken (in milliseconds) to complete the last update.
- Returns
- false if called before the initial update, true otherwise.
|
inline |
Shows the maximum number of lights that can be used within the window associated with this control.
- Parameters
-
out_lights The 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.
|
inline |
Shows the maximum texture size that can be used.
- Parameters
-
out_width The maximum texture width that can be used. out_height The maximum texture height that can be used.
- Returns
- true if the maximum texture size can be queried from the hardware, false otherwise.
|
inline |
Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
- Parameters
-
out_width The width of the physical display in pixels. out_height The height of the physical display in pixels.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
- Parameters
-
out_width The width of the physical display in centimeters. out_height The height of the physical display in centimeters.
- Returns
- true if the setting is valid, false otherwise.
|
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_aspect The aspect ratio of the window defined as width / height in pixels.
- Returns
- true if the setting is valid, false otherwise.
|
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_horizontal The horizontal resolution of the window. out_vertical The vertical resolution of the window.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the number (in MB) of video memory available on the system.
- Parameters
-
out_video_memory The number (in MB) of video memory available on the system.
- Returns
- true if video memory can be queried from the hardware, false otherwise.
|
inline |
Shows the aspect ratio of the window. Aspect ratio is computed as width / height in centimeters.
- Parameters
-
out_window_aspect The aspect ratio of the window defined as width / height in centimeters.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the number of pixels in the window.
- Parameters
-
out_width The width of the window in pixels. out_height The height of the window in pixels.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the size, in centimeters, of the window.
- Parameters
-
out_width The width of the window in centimeters. out_height The height of the window in centimeters.
- Returns
- true if the setting is valid, false otherwise.
|
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.
- 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