
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.WindowInfoKit in_kit) |
Check if the source WindowInfoKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.WindowInfoKit in_kit) |
Copies the source WindowInfoKit into this object. More... | |
HPS.WindowInfoKit | SetPhysicalPixels (uint in_width, uint in_height) |
Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | SetPhysicalSize (float in_width, float in_height) |
Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | SetWindowPixels (uint in_width, uint in_height) |
Sets the number of pixels in the window. More... | |
HPS.WindowInfoKit | SetWindowSize (float in_width, float in_height) |
Sets the size, in centimeters, of the window. More... | |
void | Show (out HPS.WindowInfoKit out_kit) |
Copies this object into the given WindowInfoKit. 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 | 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... | |
HPS.WindowInfoKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.WindowInfoKit | UnsetPhysicalPixels () |
Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | UnsetPhysicalSize () |
Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More... | |
HPS.WindowInfoKit | UnsetWindowPixels () |
Unsets the number of pixels in the window. More... | |
HPS.WindowInfoKit | UnsetWindowSize () |
Unsets the size, in centimeters, of the window. More... | |
WindowInfoKit () | |
Initializes an empty kit. More... | |
WindowInfoKit (HPS.WindowInfoKit in_kit) | |
Copies the kit in_kit into this kit. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.WindowInfoKit a, HPS.WindowInfoKit b) |
static bool | operator== (HPS.WindowInfoKit a, HPS.WindowInfoKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.
Constructor & Destructor Documentation
|
inline |
Initializes an empty kit.
|
inline |
Copies the kit in_kit into this kit.
Member Function Documentation
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source WindowInfoKit is equivalent to this object.
- Parameters
-
in_kit The source WindowInfoKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source WindowInfoKit into this object.
- Parameters
-
in_kit The source object to copy.
|
inline |
Sets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
- Parameters
-
in_width The width of the physical display in pixels. in_height The height of the physical display in pixels.
- Returns
- A reference to this object.
|
inline |
Sets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
- Parameters
-
in_width The width of the physical display in centimeters. in_height The height of the physical display in centimeters.
- Returns
- A reference to this object.
|
inline |
Sets the number of pixels in the window.
- Parameters
-
in_width The width of the window in pixels. in_height The height of the window in pixels.
- Returns
- A reference to this object.
|
inline |
Sets the size, in centimeters, of the window.
- Parameters
-
in_width The width of the window in centimeters. in_height The height of the window in centimeters.
- Returns
- A reference to this object.
|
inline |
Copies this object into the given WindowInfoKit.
- Parameters
-
out_kit The WindowInfoKit to populate with the contents of this object.
|
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 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.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
- Returns
- A reference to this object.
|
inline |
Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
- Returns
- A reference to this object.
|
inline |
Unsets the number of pixels in the window.
- Returns
- A reference to this object.
|
inline |
Unsets the size, in centimeters, of the window.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.WindowInfoKit.cs