ApplicationWindowOptionsControl

class HPS.ApplicationWindowOptionsControl : public HPS.Control 

The HPS.ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS.ApplicationWindowKey. Default values for the various fields of HPS.ApplicationWindowOptionsControl can be found here.

Public Functions

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

ApplicationWindowOptionsControl (HPS.ApplicationWindowOptionsControl in_that)

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

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.

Sets the anti-alias options for this ApplicationWindowOptionsControl.

Param in_state: Whether the associated application window should be anti-alias capable.
Return: A reference to this StandAloneWindowOptionsKit.

HPS.ApplicationWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)

Sets the anti-alias options for this ApplicationWindowOptionsControl.

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

HPS.ApplicationWindowOptionsControl SetPlatformData (IntPtr in_platform_data)

Sets the platform specific data for the associated application window.

Param in_platform_data: Platform specific data for the associated application window.
Return: A reference to this ApplicationWindowOptionsControl.

HPS.ApplicationWindowOptionsControl SetScreenAntiAliasing (bool in_state)

Manipulates the state of screen anti-aliasing.

HPS.ApplicationWindowOptionsControl SetWindowHandle (IntPtr in_window_handle)

Sets the window handle for the associated application window. Used to rebind the application window to a new window handle.

Param in_window_handle: Handle to the new WindowHandle that Visualize will draw into.
Return: A reference to this ApplicationWindowOptionsControl.

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

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

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

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

Shows the driver for the associated application window.

bool ShowFramebufferRetention (out bool out_retain)

Shows the framebuffer retention setting for the associated application window.

Param out_retain: The framebuffer retention setting for the associated application window.
Return: true if framebuffer retention option was set, false otherwise.

bool ShowPlatformData (out IntPtr out_platform_data)

Shows the platform specific data for the associated application window.

Param out_platform_data: The platform specific data for the associated application window.
Return: true if platform specific data was set, false otherwise.

bool ShowWindowHandle (out IntPtr out_window_handle)

Shows the window handle for the associated application window.

Param out_window_handle: The window handle for the associated application window.
Return: true if a window handle was set, false otherwise.

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