Inheritance diagram for HPS.WindowInfoKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.WindowInfoKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.WindowInfoKit in_kit)
 
HPS.WindowInfoKit SetPhysicalPixels (uint in_width, uint in_height)
 
HPS.WindowInfoKit SetPhysicalSize (float in_width, float in_height)
 
HPS.WindowInfoKit SetWindowPixels (uint in_width, uint in_height)
 
HPS.WindowInfoKit SetWindowSize (float in_width, float in_height)
 
void Show (out HPS.WindowInfoKit out_kit)
 
bool ShowPhysicalPixels (out uint out_width, out uint out_height)
 
bool ShowPhysicalSize (out float out_width, out float out_height)
 
bool ShowPixelAspectRatio (out float out_pixel_aspect)
 
bool ShowResolution (out float out_horizontal, out float out_vertical)
 
bool ShowWindowAspectRatio (out float out_window_aspect)
 
bool ShowWindowPixels (out uint out_width, out uint out_height)
 
bool ShowWindowSize (out float out_width, out float out_height)
 
HPS.WindowInfoKit UnsetEverything ()
 
HPS.WindowInfoKit UnsetPhysicalPixels ()
 
HPS.WindowInfoKit UnsetPhysicalSize ()
 
HPS.WindowInfoKit UnsetWindowPixels ()
 
HPS.WindowInfoKit UnsetWindowSize ()
 
 WindowInfoKit ()
 
 WindowInfoKit (HPS.WindowInfoKit in_kit)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.WindowInfoKit a, HPS.WindowInfoKit b)
 
static bool operator== (HPS.WindowInfoKit a, HPS.WindowInfoKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The WindowInfoKit class is a user space object, useful for carrying a group attribute settings.

Constructor & Destructor Documentation

◆ WindowInfoKit() [1/2]

HPS.WindowInfoKit.WindowInfoKit ( )
inline

Initializes an empty kit.

◆ WindowInfoKit() [2/2]

HPS.WindowInfoKit.WindowInfoKit ( HPS.WindowInfoKit  in_kit)
inline

Copies the kit in_kit into this kit.

Member Function Documentation

◆ 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()

bool HPS.WindowInfoKit.Equals ( HPS.WindowInfoKit  in_kit)
inline

Check if the source WindowInfoKit is equivalent to this object.

Parameters
in_kitThe source WindowInfoKit to compare to this object.
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()

void HPS.WindowInfoKit.Set ( HPS.WindowInfoKit  in_kit)
inline

Copies the source WindowInfoKit into this object.

Parameters
in_kitThe 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_widthThe width of the physical display in pixels.
in_heightThe 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_widthThe width of the physical display in centimeters.
in_heightThe 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_widthThe width of the window in pixels.
in_heightThe 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_widthThe width of the window in centimeters.
in_heightThe height of the window in centimeters.
Returns
A reference to this object.

◆ Show()

void HPS.WindowInfoKit.Show ( out HPS.WindowInfoKit  out_kit)
inline

Copies this object into the given WindowInfoKit.

Parameters
out_kitThe 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_widthThe width of the physical display in pixels.
out_heightThe 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_widthThe width of the physical display in centimeters.
out_heightThe 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_aspectThe 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_horizontalThe horizontal resolution of the window.
out_verticalThe 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_aspectThe 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_widthThe width of the window in pixels.
out_heightThe 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_widthThe width of the window in centimeters.
out_heightThe height of the window in centimeters.
Returns
true if the setting is valid, false otherwise.

◆ UnsetEverything()

HPS.WindowInfoKit HPS.WindowInfoKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetPhysicalPixels()

HPS.WindowInfoKit HPS.WindowInfoKit.UnsetPhysicalPixels ( )
inline

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

Returns
A reference to this object.

◆ UnsetPhysicalSize()

HPS.WindowInfoKit HPS.WindowInfoKit.UnsetPhysicalSize ( )
inline

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

Returns
A reference to this object.

◆ UnsetWindowPixels()

HPS.WindowInfoKit HPS.WindowInfoKit.UnsetWindowPixels ( )
inline

Unsets the number of pixels in the window.

Returns
A reference to this object.

◆ UnsetWindowSize()

HPS.WindowInfoKit HPS.WindowInfoKit.UnsetWindowSize ( )
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