|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.
◆ WindowInfoKit() [1/2]
HPS.WindowInfoKit.WindowInfoKit |
( |
| ) |
|
|
inline |
Initializes an empty kit.
◆ WindowInfoKit() [2/2]
Copies the kit in_kit into this kit.
◆ Empty()
override bool HPS.WindowInfoKit.Empty |
( |
| ) |
|
|
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.
◆ Equals()
Check if the source WindowInfoKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
override HPS.Type HPS.WindowInfoKit.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.Kit.
◆ Set()
Copies the source WindowInfoKit into this object.
- Parameters
-
in_kit | The source object to copy. |
◆ SetPhysicalPixels()
HPS.WindowInfoKit HPS.WindowInfoKit.SetPhysicalPixels |
( |
uint |
in_width, |
|
|
uint |
in_height |
|
) |
| |
|
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.
◆ SetPhysicalSize()
HPS.WindowInfoKit HPS.WindowInfoKit.SetPhysicalSize |
( |
float |
in_width, |
|
|
float |
in_height |
|
) |
| |
|
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.
◆ SetWindowPixels()
HPS.WindowInfoKit HPS.WindowInfoKit.SetWindowPixels |
( |
uint |
in_width, |
|
|
uint |
in_height |
|
) |
| |
|
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.
◆ SetWindowSize()
HPS.WindowInfoKit HPS.WindowInfoKit.SetWindowSize |
( |
float |
in_width, |
|
|
float |
in_height |
|
) |
| |
|
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.
◆ Show()
Copies this object into the given WindowInfoKit.
- Parameters
-
out_kit | The WindowInfoKit to populate with the contents of this object. |
◆ ShowPhysicalPixels()
bool HPS.WindowInfoKit.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_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.
◆ ShowPhysicalSize()
bool HPS.WindowInfoKit.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_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.
◆ ShowPixelAspectRatio()
bool HPS.WindowInfoKit.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_aspect | The aspect ratio of the window defined as width / height in pixels. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowResolution()
bool HPS.WindowInfoKit.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_horizontal | The horizontal resolution of the window. |
out_vertical | The vertical resolution of the window. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowWindowAspectRatio()
bool HPS.WindowInfoKit.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_aspect | The aspect ratio of the window defined as width / height in centimeters. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowWindowPixels()
bool HPS.WindowInfoKit.ShowWindowPixels |
( |
out uint |
out_width, |
|
|
out uint |
out_height |
|
) |
| |
|
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.
◆ ShowWindowSize()
bool HPS.WindowInfoKit.ShowWindowSize |
( |
out float |
out_width, |
|
|
out float |
out_height |
|
) |
| |
|
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.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetPhysicalPixels()
Unsets the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).
- Returns
- A reference to this object.
◆ UnsetPhysicalSize()
Unsets the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).
- Returns
- A reference to this object.
◆ UnsetWindowPixels()
Unsets the number of pixels in the window.
- Returns
- A reference to this object.
◆ UnsetWindowSize()
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