StandAloneWindowOptionsControl

class HPS.StandAloneWindowOptionsControl : public HPS.Control 

The HPS.StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS.StandAloneWindowKey.

Default values for the various fields of HPS.StandAloneWindowOptionsControl can be found here.

Standalone windows are not supported on Android, iOS, or macOS as all GUI / windowing is controlled at the application level.

Public Functions

override void Dispose ()

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

HPS.StandAloneWindowOptionsControl SetAntiAliasCapable (bool in_state)

Sets the anti-alias options for this StandAloneWindowOptionsControl.

Param in_state: Whether the associated stand-alone window should be anti-alias capable.
Return: A reference to this StandAloneWindowOptionsControl.

HPS.StandAloneWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)

Sets the anti-alias options for this StandAloneWindowOptionsControl.

Param in_state: Whether the associated stand-alone window should be anti-alias capable.
Param in_samples: The number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.
Return: A reference to this StandAloneWindowOptionsControl.

HPS.StandAloneWindowOptionsControl SetFallbackFonts (string[] in_fonts)

HPS.StandAloneWindowOptionsControl SetFullScreen (bool in_state)

Sets whether this stand-alone window should fill the screen.

Param in_state: Whether this stand-alone window should fill the screen.
Return: A reference to this StandAloneWindowOptionsControl.

HPS.StandAloneWindowOptionsControl SetMobility (HPS.Window.Mobility in_mobility)

Sets the mobility for this stand-alone window. Mobility refers to the resizing and positioning behaviors of a window.

Param in_mobility: The mobility for this stand-alone window.
Return: A reference to this StandAloneWindowOptionsControl.

HPS.StandAloneWindowOptionsControl SetScreenAntiAliasing (bool in_state)

Manipulates the state of screen anti-aliasing.

Param in_state: Whether screen anti-aliasing should be used.
Return: A reference to this object.

HPS.StandAloneWindowOptionsControl SetSubscreen (HPS.Rectangle in_subscreen)

Sets the subscreen to render into for this stand-alone window.

Param in_subscreen: The subscreen to render into for this stand-alone window. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window.
Return: A reference to this StandAloneWindowOptionsControl.

bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)

Shows the whether this stand-alone window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.

Param out_state: Whether this stand-alone window is anti-alias capable.
Param out_samples: The number of anti-alias samples supported by this stand-alone window.
Return: true if any anti-alias options were set, false otherwise.

bool ShowDriver (out HPS.Window.Driver out_driver)

Shows the driver for this stand-alone window.

Param out_driver: The driver for this stand-alone window.
Return: true if a driver was set, false otherwise.

ulong ShowFallbackFonts (out string[] out_fonts)

bool ShowFullScreen (out bool out_state)

Shows whether this stand-alone window should fill the screen.

Param out_state: Whether this stand-alone window should fill the screen.
Return: true if a full screen flag was set, false otherwise.

bool ShowMobility (out HPS.Window.Mobility out_mobility)

Shows the mobility for this stand-alone window.

Param out_mobility: The mobility for this stand-alone window.
Return: true if a mobility was set, false otherwise.

bool ShowSubscreen (out HPS.Rectangle out_subscreen)

Shows the subscreen for this stand-alone window.

Param out_subscreen: The subscreen for this stand-alone window.
Return: true if a subscreen was set, false otherwise.

bool ShowTitle (out string out_window_name)

Shows the title for this stand-alone window.

Param out_window_name: UTF8-encoded title for this stand-alone window.
Return: true if a title was set, false otherwise.

bool ShowWindowHandle (out IntPtr out_window_handle)

Shows the window handle for the associated standalone window.

Param out_window_handle: The window handle for the associated standalone window.
Return: true if a window handle is available, false otherwise.

StandAloneWindowOptionsControl (HPS.StandAloneWindowKey in_seg): This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window.

StandAloneWindowOptionsControl (HPS.StandAloneWindowOptionsControl in_that)

The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl.

Param in_that: The source StandAloneWindowOptionsControl to copy.

HPS.StandAloneWindowOptionsControl UnsetFallbackFonts (): Unsets any fonts currently used as fallback fonts.