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

explicit ApplicationWindowOptionsControl(ApplicationWindowKey &in_seg)

This constructor creates a ApplicationWindowOptionsControl object which is tied to the specified offscreen window.

Parameters: in_window – The application window which this ApplicationWindowOptionsControl should operate on.

ApplicationWindowOptionsControl(ApplicationWindowOptionsControl &&in_that)

The move constructor creates an ApplicationWindowOptionsControl by transferring the underlying impl of the rvalue reference to this ApplicationWindowOptionsControl thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to an ApplicationWindowOptionsControl to take the impl from.

ApplicationWindowOptionsControl(ApplicationWindowOptionsControl const &in_that)

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

Parameters: in_that – The source ApplicationWindowOptionsControl to copy.

inline virtual HPS::Type ObjectType() const

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.

ApplicationWindowOptionsControl &operator=(ApplicationWindowOptionsControl &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ApplicationWindowOptionsControl thereby avoiding a copy.

Parameters: in_that – An rvalue reference to an ApplicationWindowOptionsControl to take the impl from.
Returns: A reference to this ApplicationWindowOptionsControl.

ApplicationWindowOptionsControl &operator=(ApplicationWindowOptionsControl const &in_that)

Share the underlying smart-pointer of the ApplicationWindowOptionsControl source.

Parameters: in_that – The ApplicationWindowOptionsControl source of the assignment.
Returns: A reference to this ApplicationWindowOptionsControl.

ApplicationWindowOptionsControl &SetAntiAliasCapable(bool in_state, unsigned int in_samples = 4)

Sets the anti-alias options for this ApplicationWindowOptionsControl.

Parameters

in_state – Whether the associated application window should be anti-alias capable.
in_samples – The number of anti-alias samples to use for the associated application window. Defaults to 4.

Returns

A reference to this StandAloneWindowOptionsKit.

ApplicationWindowOptionsControl &SetFallbackFonts(UTF8Array const &in_fonts)

Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.

Parameters: in_fonts – An array of UTF8 encoded strings that correspond to the fallback fonts being used.

ApplicationWindowOptionsControl &SetPlatformData(PlatformData in_platform_data)

Sets the platform specific data for the associated application window.

Parameters: in_platform_data – Platform specific data for the associated application window.
Returns: A reference to this ApplicationWindowOptionsControl.

ApplicationWindowOptionsControl &SetScreenAntiAliasing(bool in_state)

Manipulates the state of screen anti-aliasing.

Parameters: in_state – Whether screen anti-aliasing should be used.
Returns: A reference to this object.

ApplicationWindowOptionsControl &SetWindowHandle(WindowHandle in_window_handle)

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

Parameters: in_window_handle – Handle to the new WindowHandle that Visualize will draw into.
Returns: A reference to this ApplicationWindowOptionsControl.

bool ShowAntiAliasCapable(bool &out_state, unsigned int &out_samples) const

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

Parameters

out_state – Whether this application window is anti-alias capable.
out_samples – The number of anti-alias samples supported by this application window.

Returns

true if any anti-alias options were set, false otherwise.

bool ShowDriver(Window::Driver &out_driver) const

Shows the driver for the associated application window.

Parameters: out_driver – The driver for the associated application window.
Returns: true if a driver was set, false otherwise.

size_t ShowFallbackFonts(UTF8Array &out_fonts) const

Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font.

Parameters: out_fonts – An array of UTF8 encoded strings that correspond to the fallback fonts being used.

bool ShowFramebufferRetention(bool &out_retain) const

Shows the framebuffer retention setting for the associated application window.

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

bool ShowPlatformData(PlatformData &out_platform_data) const

Shows the platform specific data for the associated application window.

Parameters: out_platform_data – The platform specific data for the associated application window.
Returns: true if platform specific data was set, false otherwise.

bool ShowWindowHandle(WindowHandle &out_window_handle) const

Shows the window handle for the associated application window.

Parameters: out_window_handle – The window handle for the associated application window.
Returns: true if a window handle was set, false otherwise.

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

~ApplicationWindowOptionsControl(): Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::ApplicationWindowOptionsControl