More...

Inheritance diagram for HPS.StandAloneWindowOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this StandAloneWindowOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.StandAloneWindowOptionsKit in_kit)
 Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.StandAloneWindowOptionsKit in_kit)
 Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)
 Sets the anti-alias options for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state)
 Sets the anti-alias options for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetDriver (HPS.Window.Driver in_driver)
 Sets the driver for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetFullScreen (bool in_state)
 Sets whether the associated stand-alone window should fill the screen. More...
 
HPS.StandAloneWindowOptionsKit SetMobility (HPS.Window.Mobility in_mobility)
 Sets the mobility for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetSubscreen (HPS.Rectangle in_subscreen)
 Sets the subscreen to render into for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit SetTitle (string in_window_name)
 Sets the title for this StandAloneWindowOptionsKit. More...
 
void Show (out HPS.StandAloneWindowOptionsKit out_kit)
 Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit. More...
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 Shows the anti-alias options for this StandAloneWindowOptionsKit. More...
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 Shows the driver for this StandAloneWindowOptionsKit. More...
 
bool ShowFullScreen (out bool out_state)
 Shows whether the associated stand-alone window should fill the screen. More...
 
bool ShowMobility (out HPS.Window.Mobility out_mobility)
 Shows the mobility for this StandAloneWindowOptionsKit. More...
 
bool ShowSubscreen (out HPS.Rectangle out_subscreen)
 Shows the subscreen for this StandAloneWindowOptionsKit. More...
 
bool ShowTitle (out string out_window_name)
 Shows the title for this StandAloneWindowOptionsKit. More...
 
 StandAloneWindowOptionsKit ()
 The default constructor creates an empty StandAloneWindowOptionsKit object. More...
 
 StandAloneWindowOptionsKit (HPS.StandAloneWindowOptionsKit in_kit)
 The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetAntiAliasCapable ()
 Removes the anti-alias options for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetDriver ()
 Removes the driver for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetEverything ()
 Removes all settings from this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetFullScreen ()
 Removes whether the associated stand-alone window should fill the screen. More...
 
HPS.StandAloneWindowOptionsKit UnsetMobility ()
 Removes the mobility for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetSubscreen ()
 Removes the subscreen for this StandAloneWindowOptionsKit. More...
 
HPS.StandAloneWindowOptionsKit UnsetTitle ()
 Removes the title for this StandAloneWindowOptionsKit. More...
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
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...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. 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...
 

Static Public Member Functions

static
HPS.StandAloneWindowOptionsKit 
GetDefault ()
 Creates an StandAloneWindowOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More...
 
static bool operator!= (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit b)
 
static bool operator== (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The StandAloneWindowOptionsKit class is a user space object. It is used to specify stand-alone-window-specific options Calling HPS.StandAloneWindowOptionsKit.GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

HPS.StandAloneWindowOptionsKit.StandAloneWindowOptionsKit ( )
inline

The default constructor creates an empty StandAloneWindowOptionsKit object.

HPS.StandAloneWindowOptionsKit.StandAloneWindowOptionsKit ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.

Member Function Documentation

override bool HPS.StandAloneWindowOptionsKit.Empty ( )
inlinevirtual

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

Returns
    true if no values are set on this StandAloneWindowOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.StandAloneWindowOptionsKit.Equals ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns
    true if the objects are equivalent, false otherwise.
static HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.GetDefault ( )
inlinestatic

Creates an StandAloneWindowOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
    An StandAloneWindowOptionsKit with the default settings.
override HPS.Type HPS.StandAloneWindowOptionsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
    The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

void HPS.StandAloneWindowOptionsKit.Set ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetAntiAliasCapable ( bool  in_state,
uint  in_samples 
)
inline

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
in_stateWhether the associated application 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 StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetAntiAliasCapable ( bool  in_state)
inline

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetDriver ( HPS.Window.Driver  in_driver)
inline

Sets the driver for this StandAloneWindowOptionsKit.

Parameters
in_driverThe driver for this StandAloneWindowOptionsKit.
Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetFullScreen ( bool  in_state)
inline

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

Parameters
in_stateWhether the associated stand-alone window should fill the screen.
Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetMobility ( HPS.Window.Mobility  in_mobility)
inline

Sets the mobility for this StandAloneWindowOptionsKit.

Parameters
in_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetSubscreen ( HPS.Rectangle  in_subscreen)
inline

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

Parameters
in_subscreenThe subscreen to render into for this StandAloneWindowOptionsKit. 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 StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetTitle ( string  in_window_name)
inline

Sets the title for this StandAloneWindowOptionsKit.

Parameters
in_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
    A reference to this StandAloneWindowOptionsKit.
void HPS.StandAloneWindowOptionsKit.Show ( out HPS.StandAloneWindowOptionsKit  out_kit)
inline

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

Parameters
out_kitThe StandAloneWindowOptionsKit to populate with the contents of this StandAloneWindowOptionsKit.
bool HPS.StandAloneWindowOptionsKit.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)
inline

Shows the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
out_stateWhether the associated stand-alone window should be anti-alias capable.
out_samplesThe number of anti-alias samples to use for the stand-alone application window.
Returns
    true if anti-alias options were set, false otherwise.
bool HPS.StandAloneWindowOptionsKit.ShowDriver ( out HPS.Window.Driver  out_driver)
inline

Shows the driver for this StandAloneWindowOptionsKit.

Parameters
out_driverThe driver for this StandAloneWindowOptionsKit.
Returns
    true if a driver was set, false otherwise.
bool HPS.StandAloneWindowOptionsKit.ShowFullScreen ( out bool  out_state)
inline

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

Parameters
out_stateWhether the associated stand-alone window should fill the screen.
Returns
    true if a full screen flag was set, false otherwise.
bool HPS.StandAloneWindowOptionsKit.ShowMobility ( out HPS.Window.Mobility  out_mobility)
inline

Shows the mobility for this StandAloneWindowOptionsKit.

Parameters
out_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
    true if a mobility was set, false otherwise.
bool HPS.StandAloneWindowOptionsKit.ShowSubscreen ( out HPS.Rectangle  out_subscreen)
inline

Shows the subscreen for this StandAloneWindowOptionsKit.

Parameters
out_subscreenThe subscreen for this StandAloneWindowOptionsKit.
Returns
    true if a subscreen was set, false otherwise.
bool HPS.StandAloneWindowOptionsKit.ShowTitle ( out string  out_window_name)
inline

Shows the title for this StandAloneWindowOptionsKit.

Parameters
out_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
    true if a title was set, false otherwise.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetAntiAliasCapable ( )
inline

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetDriver ( )
inline

Removes the driver for this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetEverything ( )
inline

Removes all settings from this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetFullScreen ( )
inline

Removes whether the associated stand-alone window should fill the screen.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetMobility ( )
inline

Removes the mobility for this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetSubscreen ( )
inline

Removes the subscreen for this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.
HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetTitle ( )
inline

Removes the title for this StandAloneWindowOptionsKit.

Returns
    A reference to this StandAloneWindowOptionsKit.

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