#include <hps.h>

Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
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
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::PerformanceControl::PerformanceControl | ( | PerformanceControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::PerformanceControl::PerformanceControl | ( | PerformanceControl && | in_that | ) |
The move constructor creates a PerformanceControl by transferring the underlying impl of the rvalue reference to this PerformanceControl thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a PerformanceControl to take the impl from.
HPS::PerformanceControl::~PerformanceControl | ( | ) |
Releases a reference to the database object this control is tied to.
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::Control.
PerformanceControl& HPS::PerformanceControl::operator= | ( | PerformanceControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this PerformanceControl thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a PerformanceControl to take the impl from.
- Returns
- A reference to this PerformanceControl.
PerformanceControl& HPS::PerformanceControl::operator= | ( | PerformanceControl const & | in_that | ) |
Share the underlying smart-pointer of the PerformanceControl source.
- Parameters
-
in_that The PerformanceControl source of the assignment.
- Returns
- A reference to this PerformanceControl.
PerformanceControl& HPS::PerformanceControl::SetDisplayLists | ( | Performance::DisplayLists | in_display_list = Performance::DisplayLists::Segment | ) |
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.
PerformanceControl& HPS::PerformanceControl::SetStaticModel | ( | 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.
- Parameters
-
in_model_type The type of static tree, if any, that should be used.
- Returns
- A reference to this object.
bool HPS::PerformanceControl::ShowDisplayLists | ( | Performance::DisplayLists & | out_display_list | ) | const |
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.
bool HPS::PerformanceControl::ShowStaticModel | ( | Performance::StaticModel & | out_model_type | ) | const |
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.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
PerformanceControl& HPS::PerformanceControl::UnsetDisplayLists | ( | ) |
Removes the display list setting.
- Returns
- A reference to this object.
PerformanceControl& HPS::PerformanceControl::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
PerformanceControl& HPS::PerformanceControl::UnsetStaticModel | ( | ) |
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:
- include/hps.h