HPS::ApplicationWindowOptionsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::ApplicationWindowOptionsControl:
HPS::Control HPS::Object

Public Member Functions

 ApplicationWindowOptionsControl (ApplicationWindowKey &in_seg)
 
 ApplicationWindowOptionsControl (ApplicationWindowOptionsControl const &in_that)
 
 ApplicationWindowOptionsControl (ApplicationWindowOptionsControl &&in_that)
 
HPS::Type ObjectType () const
 
ApplicationWindowOptionsControloperator= (ApplicationWindowOptionsControl &&in_that)
 
ApplicationWindowOptionsControloperator= (ApplicationWindowOptionsControl const &in_that)
 
ApplicationWindowOptionsControlSetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
 
ApplicationWindowOptionsControlSetFallbackFonts (UTF8Array const &in_fonts)
 
ApplicationWindowOptionsControlSetPlatformData (PlatformData in_platform_data)
 
ApplicationWindowOptionsControlSetScreenAntiAliasing (bool in_state)
 
ApplicationWindowOptionsControlSetWindowHandle (WindowHandle in_window_handle)
 
bool ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
 
bool ShowDriver (Window::Driver &out_driver) const
 
size_t ShowFallbackFonts (UTF8Array &out_fonts) const
 
bool ShowFramebufferRetention (bool &out_retain) const
 
bool ShowPlatformData (PlatformData &out_platform_data) const
 
bool ShowWindowHandle (WindowHandle &out_window_handle) const
 
virtual HPS::Type Type () const
 
ApplicationWindowOptionsControlUnsetFallbackFonts ()
 
 ~ApplicationWindowOptionsControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ApplicationWindowOptionsControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ApplicationWindowOptionsControl() [1/3]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl ( ApplicationWindowKey in_seg)
explicit

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

Parameters
in_windowThe application window which this ApplicationWindowOptionsControl should operate on.

◆ ApplicationWindowOptionsControl() [2/3]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl ( ApplicationWindowOptionsControl const &  in_that)

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

Parameters
in_thatThe source ApplicationWindowOptionsControl to copy.

◆ ApplicationWindowOptionsControl() [3/3]

HPS::ApplicationWindowOptionsControl::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_thatAn rvalue reference to an ApplicationWindowOptionsControl to take the impl from.

◆ ~ApplicationWindowOptionsControl()

HPS::ApplicationWindowOptionsControl::~ApplicationWindowOptionsControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::ApplicationWindowOptionsControl::ObjectType ( ) const
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::Control.

◆ operator=() [1/2]

ApplicationWindowOptionsControl& HPS::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_thatAn rvalue reference to an ApplicationWindowOptionsControl to take the impl from.
Returns
A reference to this ApplicationWindowOptionsControl.

◆ operator=() [2/2]

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::operator= ( ApplicationWindowOptionsControl const &  in_that)

Share the underlying smart-pointer of the ApplicationWindowOptionsControl source.

Parameters
in_thatThe ApplicationWindowOptionsControl source of the assignment.
Returns
A reference to this ApplicationWindowOptionsControl.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this ApplicationWindowOptionsControl.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated application window. Defaults to 4.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetFallbackFonts()

ApplicationWindowOptionsControl& HPS::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_fontsAn array of UTF8 encoded strings that correspond to the fallback fonts being used.

◆ SetPlatformData()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::SetPlatformData ( PlatformData  in_platform_data)

Sets the platform specific data for the associated application window.

Parameters
in_platform_dataPlatform specific data for the associated application window.
Returns
A reference to this ApplicationWindowOptionsControl.

◆ SetScreenAntiAliasing()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::SetScreenAntiAliasing ( bool  in_state)

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ SetWindowHandle()

ApplicationWindowOptionsControl& HPS::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_handleHandle to the new WindowHandle that Visualize will draw into.
Returns
A reference to this ApplicationWindowOptionsControl.

◆ ShowAntiAliasCapable()

bool HPS::ApplicationWindowOptionsControl::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_stateWhether this application window is anti-alias capable.
out_samplesThe number of anti-alias samples supported by this application window.
Returns
true if any anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS::ApplicationWindowOptionsControl::ShowDriver ( Window::Driver out_driver) const

Shows the driver for the associated application window.

Parameters
out_driverThe driver for the associated application window.
Returns
true if a driver was set, false otherwise.

◆ ShowFallbackFonts()

size_t HPS::ApplicationWindowOptionsControl::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_fontsAn array of UTF8 encoded strings that correspond to the fallback fonts being used.

◆ ShowFramebufferRetention()

bool HPS::ApplicationWindowOptionsControl::ShowFramebufferRetention ( bool &  out_retain) const

Shows the framebuffer retention setting for the associated application window.

Parameters
out_retainThe framebuffer retention setting for the associated application window.
Returns
true if framebuffer retention option was set, false otherwise.

◆ ShowPlatformData()

bool HPS::ApplicationWindowOptionsControl::ShowPlatformData ( PlatformData &  out_platform_data) const

Shows the platform specific data for the associated application window.

Parameters
out_platform_dataThe platform specific data for the associated application window.
Returns
true if platform specific data was set, false otherwise.

◆ ShowWindowHandle()

bool HPS::ApplicationWindowOptionsControl::ShowWindowHandle ( WindowHandle &  out_window_handle) const

Shows the window handle for the associated application window.

Parameters
out_window_handleThe window handle for the associated application window.
Returns
true if a window handle was set, false otherwise.

◆ Type()

virtual HPS::Type HPS::ApplicationWindowOptionsControl::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetFallbackFonts()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::UnsetFallbackFonts ( )

Unsets any fonts currently used as fallback fonts.


The documentation for this class was generated from the following file: