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

Public Member Functions | |
override void | Dispose () |
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... | |
PerformanceControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
PerformanceControl (HPS.PerformanceControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
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. More... | |
HPS.PerformanceControl | SetDisplayLists () |
Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance. More... | |
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. More... | |
bool | ShowDisplayLists (out HPS.Performance.DisplayLists out_display_list) |
Shows the display list state. More... | |
bool | ShowStaticModel (out HPS.Performance.StaticModel out_model_type) |
Shows the static model state. More... | |
HPS.PerformanceControl | UnsetDisplayLists () |
Removes the display list setting. More... | |
HPS.PerformanceControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.PerformanceControl | UnsetStaticModel () |
Removes the static model state, releasing the compiled draw tree. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
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... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
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.Object.
|
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_list The type of display lists, if any, that should be used.
- Returns
- A reference to this object.
|
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.
|
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_type The type of static tree, if any, that should be used.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Removes the display list setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
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.PerformanceControl.cs