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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.PerformanceKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 PerformanceKit ()
 
 PerformanceKit (HPS.PerformanceKit in_kit)
 
void Set (HPS.PerformanceKit in_kit)
 
HPS.PerformanceKit SetDisplayLists (HPS.Performance.DisplayLists in_display_list)
 
HPS.PerformanceKit SetDisplayLists ()
 
HPS.PerformanceKit SetStaticConditions (HPS.Performance.StaticConditions in_conditions)
 
HPS.PerformanceKit SetStaticModel (HPS.Performance.StaticModel in_model_type)
 
void Show (out HPS.PerformanceKit out_kit)
 
bool ShowDisplayLists (out HPS.Performance.DisplayLists out_display_list)
 
bool ShowStaticConditions (out HPS.Performance.StaticConditions out_conditions)
 
bool ShowStaticModel (out HPS.Performance.StaticModel out_model_type)
 
HPS.PerformanceKit UnsetDisplayLists ()
 
HPS.PerformanceKit UnsetEverything ()
 
HPS.PerformanceKit UnsetStaticConditions ()
 
HPS.PerformanceKit UnsetStaticModel ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.PerformanceKit GetDefault ()
 
static bool operator!= (HPS.PerformanceKit a, HPS.PerformanceKit b)
 
static bool operator== (HPS.PerformanceKit a, HPS.PerformanceKit 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 HPS.PerformanceKit class is a user space object, useful for carrying a group of attribute settings related to performance settings. Calling HPS.PerformanceKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ PerformanceKit() [1/2]

HPS.PerformanceKit.PerformanceKit ( )
inline

Initializes an empty kit.

◆ PerformanceKit() [2/2]

HPS.PerformanceKit.PerformanceKit ( HPS.PerformanceKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.PerformanceKit.Empty ( )
inlinevirtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source PerformanceKit is equivalent to this object.

Parameters
in_kitThe source PerformanceKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.PerformanceKit HPS.PerformanceKit.GetDefault ( )
inlinestatic

Creates a PerformanceKit 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
A PerformanceKit with the default settings.

◆ ObjectType()

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

◆ Set()

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

Copies the source PerformanceKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetDisplayLists() [1/2]

HPS.PerformanceKit HPS.PerformanceKit.SetDisplayLists ( HPS.Performance.DisplayLists  in_display_list)
inline

Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance.

Parameters
in_display_listThe type of display lists, if any, that should be used.
Returns
A reference to this object.

◆ SetDisplayLists() [2/2]

HPS.PerformanceKit HPS.PerformanceKit.SetDisplayLists ( )
inline

Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance.

Returns
A reference to this object.

◆ SetStaticConditions()

HPS.PerformanceKit HPS.PerformanceKit.SetStaticConditions ( HPS.Performance.StaticConditions  in_conditions)
inline

Sets the static conditions handling mode

Parameters
in_conditionsThe type of handling that should be used.
Returns
A reference to this object.

◆ SetStaticModel()

HPS.PerformanceKit HPS.PerformanceKit.SetStaticModel ( HPS.Performance.StaticModel  in_model_type)
inline

Sets the static tree state. This will create a compiled draw tree for the scene which should result in better rendering performance. It is important to note that the compiled tree will need to be regenerated if a change occurs within the segment tree.

Parameters
in_model_typeThe type of static tree, if any, that should be used.
Returns
A reference to this object.

◆ Show()

void HPS.PerformanceKit.Show ( out HPS.PerformanceKit  out_kit)
inline

Copies this object into the given PerformanceKit.

Parameters
out_kitThe PerformanceKit to populate with the contents of this object.

◆ ShowDisplayLists()

bool HPS.PerformanceKit.ShowDisplayLists ( out HPS.Performance.DisplayLists  out_display_list)
inline

Shows the display list state.

Parameters
out_display_listThe type of display lists, if any.
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticConditions()

bool HPS.PerformanceKit.ShowStaticConditions ( out HPS.Performance.StaticConditions  out_conditions)
inline

Shows the static conditions handling state.

Parameters
out_conditionsThe type of static condition handline
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticModel()

bool HPS.PerformanceKit.ShowStaticModel ( out HPS.Performance.StaticModel  out_model_type)
inline

Shows the static model state.

Parameters
out_model_typeThe type of static tree, if any
Returns
true if the setting is valid, false otherwise.

◆ UnsetDisplayLists()

HPS.PerformanceKit HPS.PerformanceKit.UnsetDisplayLists ( )
inline

Removes the display list setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.PerformanceKit HPS.PerformanceKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetStaticConditions()

HPS.PerformanceKit HPS.PerformanceKit.UnsetStaticConditions ( )
inline

Removes the static condition handling state

Returns
A reference to this object.

◆ UnsetStaticModel()

HPS.PerformanceKit HPS.PerformanceKit.UnsetStaticModel ( )
inline

Removes the static model state, releasing the compiled draw tree.

Returns
A reference to this object.

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