PerformanceKit

class HPS.PerformanceKit : HPS.Kit

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

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

bool Equals (HPS.PerformanceKit in_kit)

Check if the source PerformanceKit is equivalent to this object.

Param in_kit:The source PerformanceKit to compare to this object. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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

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

PerformanceKit ()

Initializes an empty kit.

PerformanceKit (HPS.PerformanceKit in_kit)

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

Param in_kit:The source object to copy.

void Set (HPS.PerformanceKit in_kit)

Copies the source PerformanceKit into this object.

Param in_kit:The source object to copy.

HPS.PerformanceKit SetDisplayLists ()

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

Return:A reference to this object.

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

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

Param in_display_list:  The type of display lists, if any, that should be used. Return:A reference to this object.

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

Sets the static conditions handling mode

Param in_conditions:  The type of handling that should be used. Return:A reference to this object.

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

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.

Param in_model_type:  The type of static tree, if any, that should be used. Return:A reference to this object.

HPS.PerformanceKit SetTextHardwareAcceleration (bool in_state)

Sets text hardware acceleration. Transformable text may be included if segment-level display lists are active.

Param in_state:Whether to include transformable text in segment-level display lists Return:A reference to this object.

void Show (out HPS.PerformanceKit out_kit)

Copies this object into the given PerformanceKit.

Param out_kit:The PerformanceKit to populate with the contents of this object.

bool ShowDisplayLists (out HPS.Performance.DisplayLists out_display_list)

Shows the display list state.

Param out_display_list:  The type of display lists, if any. Return:true if the setting is valid, false otherwise.

bool ShowStaticConditions (out HPS.Performance.StaticConditions out_conditions)

Shows the static conditions handling state.

Param out_conditions:  The type of static condition handline Return:true if the setting is valid, false otherwise.

bool ShowStaticModel (out HPS.Performance.StaticModel out_model_type)

Shows the static model state.

Param out_model_type:  The type of static tree, if any Return:true if the setting is valid, false otherwise.

bool ShowTextHardwareAcceleration (out bool out_state)

Shows the text hardware acceleration state.

Param out_state:  The text hardware acceleration setting, if any. Return:true if the setting is valid, false otherwise.

HPS.PerformanceKit UnsetDisplayLists ()

Removes the display list setting.

Return:A reference to this object.

HPS.PerformanceKit UnsetEverything ()

Removes all settings from this object.

Return:A reference to this object.

HPS.PerformanceKit UnsetStaticConditions ()

Removes the static condition handling state

Return:A reference to this object.

HPS.PerformanceKit UnsetStaticModel ()

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

Return:A reference to this object.

HPS.PerformanceKit UnsetTextHardwareAcceleration ()

Removes the text hardware acceleration setting.

Return:A reference to this object.

Public Static Functions

HPS.PerformanceKit GetDefault ()

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.

Return:A PerformanceKit with the default settings.

bool operator!= (HPS.PerformanceKit a, HPS.PerformanceKit b)

bool operator== (HPS.PerformanceKit a, HPS.PerformanceKit b)