|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ PerformanceControl() [1/2]
Initializes a control tied to the segment in_seg.
◆ PerformanceControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ ObjectType()
override HPS.Type HPS.PerformanceControl.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.
◆ SetDisplayLists() [1/2]
Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance.
- Parameters
-
in_display_list | The type of display lists, if any, that should be used. |
- Returns
- A reference to this object.
◆ SetDisplayLists() [2/2]
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()
Sets the mode for processing conditional expressions inn a static tree.
- Parameters
-
in_conditions | The type of conditional processing that should be used. |
- Returns
- A reference to this object.
◆ SetStaticModel()
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_type | The type of static tree, if any, that should be used. |
- Returns
- A reference to this object.
◆ SetTextHardwareAcceleration()
Sets text hardware acceleration. Transformable text may be included if segment-level display lists are active.
- Parameters
-
in_state | Whether to include transformable text in segment-level display lists |
- Returns
- A reference to this object.
◆ ShowDisplayLists()
Shows the display list state.
- Parameters
-
out_display_list | The type of display lists, if any. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowStaticConditions()
Shows the static conditions state.
- Parameters
-
out_conditions | The type of conditional expression processing |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowStaticModel()
Shows the static model state.
- Parameters
-
out_model_type | The type of static tree, if any |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowTextHardwareAcceleration()
bool HPS.PerformanceControl.ShowTextHardwareAcceleration |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the text hardware acceleration state.
- Parameters
-
out_state | The text hardware acceleration setting, if any. |
- Returns
- true if the setting is valid, false otherwise.
◆ Type()
override HPS.Type HPS.PerformanceControl.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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ UnsetStaticConditions()
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.PerformanceControl.cs