PerformanceControl

class HPS.PerformanceControl : public HPS.Control

The HPS.PerformanceControl class is a smart pointer that is tied to a database object. This object is used to enable and disable performance-related attributes, such as display lists and static model.

This table lists default values for the various segment attributes accessible from HPS.PerformanceControl.

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

Return

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

PerformanceControl (HPS.PerformanceControl in_that)

Initializes a control tied to the same object as in_that.

PerformanceControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

HPS.PerformanceControl 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.PerformanceControl 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.PerformanceControl SetStaticConditions (HPS.Performance.StaticConditions in_conditions)

Sets the mode for processing conditional expressions inn a static tree.

Param in_conditions

The type of conditional processing that should be used.

Return

A reference to this object.

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

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

Param out_conditions

The type of conditional expression processing

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.PerformanceControl UnsetDisplayLists ()

Removes the display list setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by PerformanceKit.GetDefault().

Return

A reference to this object.

HPS.PerformanceControl UnsetEverything ()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by PerformanceKit.GetDefault().

Return

A reference to this object.

HPS.PerformanceControl UnsetStaticConditions ()

Removes the static condition state. setting as specified by PerformanceKit.GetDefault().

Return

A reference to this object.

HPS.PerformanceControl UnsetStaticModel ()

Removes the static model state, releasing the compiled draw tree. If the control is attached to a WindowKey this function restores the default value of this setting as specified by PerformanceKit.GetDefault().

Return

A reference to this object.

HPS.PerformanceControl UnsetTextHardwareAcceleration ()

Removes the text hardware acceleration setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by PerformanceKit.GetDefault().

Return

A reference to this object.