HPS.ApplicationWindowOptionsControl Class Reference
Inheritance diagram for HPS.ApplicationWindowOptionsControl:
HPS.Control HPS.Object

Public Member Functions

 ApplicationWindowOptionsControl (HPS.ApplicationWindowKey in_seg)
 
 ApplicationWindowOptionsControl (HPS.ApplicationWindowOptionsControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.ApplicationWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)
 
HPS.ApplicationWindowOptionsControl SetAntiAliasCapable (bool in_state)
 
HPS.ApplicationWindowOptionsControl SetFallbackFonts (string[] in_fonts)
 
HPS.ApplicationWindowOptionsControl SetPlatformData (IntPtr in_platform_data)
 
HPS.ApplicationWindowOptionsControl SetScreenAntiAliasing (bool in_state)
 
HPS.ApplicationWindowOptionsControl SetWindowHandle (IntPtr in_window_handle)
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 
ulong ShowFallbackFonts (out string[] out_fonts)
 
bool ShowFramebufferRetention (out bool out_retain)
 
bool ShowPlatformData (out IntPtr out_platform_data)
 
bool ShowWindowHandle (out IntPtr out_window_handle)
 
override HPS.Type Type ()
 
HPS.ApplicationWindowOptionsControl UnsetFallbackFonts ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.ApplicationWindowOptionsControl.ApplicationWindowOptionsControl ( HPS.ApplicationWindowKey  in_seg)
inline

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

◆ ApplicationWindowOptionsControl() [2/2]

HPS.ApplicationWindowOptionsControl.ApplicationWindowOptionsControl ( HPS.ApplicationWindowOptionsControl  in_that)
inline

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

Parameters
in_thatThe source ApplicationWindowOptionsControl to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.ApplicationWindowOptionsControl.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.Object.

◆ SetAntiAliasCapable() [1/2]

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetAntiAliasCapable ( bool  in_state,
uint  in_samples 
)
inline

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.

◆ SetAntiAliasCapable() [2/2]

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetAntiAliasCapable ( bool  in_state)
inline

Sets the anti-alias options for this ApplicationWindowOptionsControl.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetFallbackFonts()

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetFallbackFonts ( string []  in_fonts)
inline

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

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetPlatformData ( IntPtr  in_platform_data)
inline

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

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetScreenAntiAliasing ( bool  in_state)
inline

Manipulates the state of screen anti-aliasing.

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

◆ SetWindowHandle()

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.SetWindowHandle ( IntPtr  in_window_handle)
inline

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 ( out bool  out_state,
out uint  out_samples 
)
inline

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 ( out HPS.Window.Driver  out_driver)
inline

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

ulong HPS.ApplicationWindowOptionsControl.ShowFallbackFonts ( out string []  out_fonts)
inline

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 ( out bool  out_retain)
inline

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 ( out IntPtr  out_platform_data)
inline

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 ( out IntPtr  out_window_handle)
inline

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

override HPS.Type HPS.ApplicationWindowOptionsControl.Type ( )
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.Object.

◆ UnsetFallbackFonts()

HPS.ApplicationWindowOptionsControl HPS.ApplicationWindowOptionsControl.UnsetFallbackFonts ( )
inline

Unsets any fonts currently used as fallback fonts.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ApplicationWindowOptionsControl.cs