HPS.StandAloneWindowOptionsControl Class Reference

More...

Inheritance diagram for HPS.StandAloneWindowOptionsControl:
HPS.Control HPS.Object

Public Member 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). More...
 
HPS.StandAloneWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)
 Sets the anti-alias options for this StandAloneWindowOptionsControl. More...
 
HPS.StandAloneWindowOptionsControl SetAntiAliasCapable (bool in_state)
 Sets the anti-alias options for this StandAloneWindowOptionsControl. More...
 
HPS.StandAloneWindowOptionsControl SetFallbackFonts (string[] in_fonts)
 Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font. More...
 
HPS.StandAloneWindowOptionsControl SetFullScreen (bool in_state)
 Sets whether this stand-alone window should fill the screen. More...
 
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. More...
 
HPS.StandAloneWindowOptionsControl SetScreenAntiAliasing (bool in_state)
 Manipulates the state of screen anti-aliasing. More...
 
HPS.StandAloneWindowOptionsControl SetSubscreen (HPS.Rectangle in_subscreen)
 Sets the subscreen to render into for this stand-alone window. More...
 
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. More...
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 Shows the driver for this stand-alone window. More...
 
ulong ShowFallbackFonts (out string[] out_fonts)
 Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font. More...
 
bool ShowFullScreen (out bool out_state)
 Shows whether this stand-alone window should fill the screen. More...
 
bool ShowMobility (out HPS.Window.Mobility out_mobility)
 Shows the mobility for this stand-alone window. More...
 
bool ShowSubscreen (out HPS.Rectangle out_subscreen)
 Shows the subscreen for this stand-alone window. More...
 
bool ShowTitle (out string out_window_name)
 Shows the title for this stand-alone window. More...
 
bool ShowWindowHandle (out IntPtr out_window_handle)
 Shows the window handle for the associated standalone window. More...
 
 StandAloneWindowOptionsControl (HPS.StandAloneWindowKey in_seg)
 This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window. More...
 
 StandAloneWindowOptionsControl (HPS.StandAloneWindowOptionsControl in_that)
 The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl. More...
 
override HPS.Type Type ()
 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. More...
 
HPS.StandAloneWindowOptionsControl UnsetFallbackFonts ()
 Unsets any fonts currently used as fallback fonts. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ StandAloneWindowOptionsControl() [1/2]

HPS.StandAloneWindowOptionsControl.StandAloneWindowOptionsControl ( HPS.StandAloneWindowKey  in_seg)
inline

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

◆ StandAloneWindowOptionsControl() [2/2]

HPS.StandAloneWindowOptionsControl.StandAloneWindowOptionsControl ( HPS.StandAloneWindowOptionsControl  in_that)
inline

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

Parameters
in_thatThe source StandAloneWindowOptionsControl to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.StandAloneWindowOptionsControl.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.Control.

◆ SetAntiAliasCapable() [1/2]

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

Sets the anti-alias options for this StandAloneWindowOptionsControl.

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

◆ SetAntiAliasCapable() [2/2]

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

Sets the anti-alias options for this StandAloneWindowOptionsControl.

Parameters
in_stateWhether the associated stand-alone window should be anti-alias capable.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetFallbackFonts()

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.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.

◆ SetFullScreen()

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.SetFullScreen ( bool  in_state)
inline

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

Parameters
in_stateWhether this stand-alone window should fill the screen.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetMobility()

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

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

Parameters
in_mobilityThe mobility for this stand-alone window.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ SetScreenAntiAliasing()

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.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.

◆ SetSubscreen()

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.SetSubscreen ( HPS.Rectangle  in_subscreen)
inline

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

Parameters
in_subscreenThe 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.
Returns
A reference to this StandAloneWindowOptionsControl.

◆ ShowAntiAliasCapable()

bool HPS.StandAloneWindowOptionsControl.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)
inline

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

Parameters
out_stateWhether this stand-alone window is anti-alias capable.
out_samplesThe number of anti-alias samples supported by this stand-alone window.
Returns
true if any anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS.StandAloneWindowOptionsControl.ShowDriver ( out HPS.Window.Driver  out_driver)
inline

Shows the driver for this stand-alone window.

Parameters
out_driverThe driver for this stand-alone window.
Returns
true if a driver was set, false otherwise.

◆ ShowFallbackFonts()

ulong HPS.StandAloneWindowOptionsControl.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.

◆ ShowFullScreen()

bool HPS.StandAloneWindowOptionsControl.ShowFullScreen ( out bool  out_state)
inline

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

Parameters
out_stateWhether this stand-alone window should fill the screen.
Returns
true if a full screen flag was set, false otherwise.

◆ ShowMobility()

bool HPS.StandAloneWindowOptionsControl.ShowMobility ( out HPS.Window.Mobility  out_mobility)
inline

Shows the mobility for this stand-alone window.

Parameters
out_mobilityThe mobility for this stand-alone window.
Returns
true if a mobility was set, false otherwise.

◆ ShowSubscreen()

bool HPS.StandAloneWindowOptionsControl.ShowSubscreen ( out HPS.Rectangle  out_subscreen)
inline

Shows the subscreen for this stand-alone window.

Parameters
out_subscreenThe subscreen for this stand-alone window.
Returns
true if a subscreen was set, false otherwise.

◆ ShowTitle()

bool HPS.StandAloneWindowOptionsControl.ShowTitle ( out string  out_window_name)
inline

Shows the title for this stand-alone window.

Parameters
out_window_nameUTF8-encoded title for this stand-alone window.
Returns
true if a title was set, false otherwise.

◆ ShowWindowHandle()

bool HPS.StandAloneWindowOptionsControl.ShowWindowHandle ( out IntPtr  out_window_handle)
inline

Shows the window handle for the associated standalone window.

Parameters
out_window_handleThe window handle for the associated standalone window.
Returns
true if a window handle is available, false otherwise.

◆ Type()

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

Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetFallbackFonts()

HPS.StandAloneWindowOptionsControl HPS.StandAloneWindowOptionsControl.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.StandAloneWindowOptionsControl.cs