#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::PerformanceKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ PerformanceKit() [1/3]
HPS::PerformanceKit::PerformanceKit |
( |
| ) |
|
Initializes an empty kit.
◆ PerformanceKit() [2/3]
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. |
◆ PerformanceKit() [3/3]
The move constructor creates a PerformanceKit by transferring the underlying impl of the rvalue reference to this PerformanceKit thereby avoiding a copy and allocation.
- Parameters
-
◆ ~PerformanceKit()
virtual HPS::PerformanceKit::~PerformanceKit |
( |
| ) |
|
|
virtual |
◆ Empty()
bool HPS::PerformanceKit::Empty |
( |
| ) |
const |
|
virtual |
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.
◆ Equals()
bool HPS::PerformanceKit::Equals |
( |
PerformanceKit const & |
in_kit | ) |
const |
Check if the source PerformanceKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
- Returns
- A PerformanceKit with the default settings.
◆ ObjectType()
HPS::Type HPS::PerformanceKit::ObjectType |
( |
| ) |
const |
|
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::Kit.
◆ operator!=()
bool HPS::PerformanceKit::operator!= |
( |
PerformanceKit const & |
in_kit | ) |
const |
Check if the source PerformanceKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this PerformanceKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this PerformanceKit.
◆ operator=() [2/2]
Copies the source PerformanceKit into this object.
- Parameters
-
- Returns
- A reference to this object.
◆ operator==()
bool HPS::PerformanceKit::operator== |
( |
PerformanceKit const & |
in_kit | ) |
const |
Check if the source PerformanceKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
Copies the source PerformanceKit into this object.
- Parameters
-
in_kit | The source object to copy. |
◆ SetDisplayLists()
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.
◆ SetStaticConditions()
Sets the static conditions handling mode
- Parameters
-
in_conditions | The type of handling 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.
◆ Show()
◆ 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 handling state.
- Parameters
-
out_conditions | The type of static condition handline |
- 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.
◆ UnsetDisplayLists()
Removes the display list setting.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetStaticConditions()
Removes the static condition handling state
- Returns
- A reference to this object.
◆ 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: