
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.PerformanceKit in_kit) |
Check if the source PerformanceKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
PerformanceKit () | |
Initializes an empty kit. More... | |
PerformanceKit (HPS.PerformanceKit in_kit) | |
The copy constructor creates a new PerformanceKit object that contains the same settings as the source object. More... | |
void | Set (HPS.PerformanceKit in_kit) |
Copies the source PerformanceKit into this object. More... | |
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. More... | |
HPS.PerformanceKit | SetDisplayLists () |
Sets the display list state. Display lists enables the drivers to cache data in video card memory for improved rendering performance. More... | |
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. More... | |
void | Show (out HPS.PerformanceKit out_kit) |
Copies this object into the given PerformanceKit. 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.PerformanceKit | UnsetDisplayLists () |
Removes the display list setting. More... | |
HPS.PerformanceKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.PerformanceKit | UnsetStaticModel () |
Removes the static model state, releasing the compiled draw tree. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
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... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.PerformanceKit a, HPS.PerformanceKit b) |
static bool | operator== (HPS.PerformanceKit a, HPS.PerformanceKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new PerformanceKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source PerformanceKit is equivalent to this object.
- Parameters
-
in_kit The source PerformanceKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
inline |
Copies the source PerformanceKit into this object.
- Parameters
-
in_kit The source object to copy.
|
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 |
Copies this object into the given PerformanceKit.
- Parameters
-
out_kit The PerformanceKit to populate with the contents of 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.PerformanceKit.cs