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... | |
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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
|
inline |
Initializes a control tied to the window segment in_window.
|
inline |
Initializes a control tied to the same object as in_that.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Shows the number of color bit planes present for each pixel in the frame buffer.
out_planes | The number of color bit planes present for each pixel in the frame buffer. |
|
inline |
Shows the number of bits used in this window's depth buffer.
out_bits | The number of bits used in this window's depth buffer. |
|
inline |
Shows the number of depth peeling layers that are supported for this window associated with this control.
out_layers | The number of depth peeling layers that are supported for this window associated with this control. |
|
inline |
Shows information pertaining to the last performed update.
out_info | The information pertaining to the last performed update. |
|
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.
out_time | The time taken (in milliseconds) to complete the last update. |
|
inline |
Shows the maximum number of lights that can be used within the window associated with this control.
out_lights | The maximum number of lights that can be used within the window associated with this control. |
|
inline |
Shows the maximum texture size that can be used.
out_width | The maximum texture width that can be used. |
out_height | The maximum texture height that can be used. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |
|
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.
out_horizontal | The horizontal resolution of the window. |
out_vertical | The vertical resolution of the window. |
|
inline |
Shows the number (in MB) of video memory available on the system.
out_video_memory | The number (in MB) of video memory available on the system. |
|
inline |
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. |
|
inline |
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. |
|
inline |
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. |