PerformanceKit

class PerformanceKit : public HPS::Kit

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.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

Returns:

true if no values are set on this object, false otherwise.

bool Equals(PerformanceKit const &in_kit) const

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.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(PerformanceKit const &in_kit) const

Check if the source PerformanceKit is not equivalent to this object.

Parameters:

in_kit – The source PerformanceKit to compare to this object.

Returns:

true if the objects are not equivalent, false otherwise.

PerformanceKit &operator=(PerformanceKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this PerformanceKit thereby avoiding a copy.

Parameters:

in_that – An rvalue reference to a PerformanceKit to take the impl from.

Returns:

A reference to this PerformanceKit.

PerformanceKit &operator=(PerformanceKit const &in_kit)

Copies the source PerformanceKit into this object.

Parameters:

in_kit – The source PerformanceKit to copy.

Returns:

A reference to this object.

bool operator==(PerformanceKit const &in_kit) const

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.

PerformanceKit()

Initializes an empty kit.

PerformanceKit(PerformanceKit &&in_that)

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:

in_that – An rvalue reference to a PerformanceKit to take the impl from.

PerformanceKit(PerformanceKit const &in_kit)

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.

void Set(PerformanceKit const &in_kit)

Copies the source PerformanceKit into this object.

Parameters:

in_kit – The source object to copy.

PerformanceKit &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.

PerformanceKit &SetStaticConditions(Performance::StaticConditions in_conditions)

Sets the static conditions handling mode

Parameters:

in_conditions – The type of handling that should be used.

Returns:

A reference to this object.

PerformanceKit &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.

PerformanceKit &SetTextHardwareAcceleration(bool in_state)

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.

void Show(PerformanceKit &out_kit) const

Copies this object into the given PerformanceKit.

Parameters:

out_kit – The PerformanceKit to populate with the contents of this object.

bool 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 ShowStaticConditions(Performance::StaticConditions &out_conditions) const

Shows the static conditions handling state.

Parameters:

out_conditions – The type of static condition handline

Returns:

true if the setting is valid, false otherwise.

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

bool ShowTextHardwareAcceleration(bool &out_state) const

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.

PerformanceKit &UnsetDisplayLists()

Removes the display list setting.

Returns:

A reference to this object.

PerformanceKit &UnsetEverything()

Removes all settings from this object.

Returns:

A reference to this object.

PerformanceKit &UnsetStaticConditions()

Removes the static condition handling state

Returns:

A reference to this object.

PerformanceKit &UnsetStaticModel()

Removes the static model state, releasing the compiled draw tree.

Returns:

A reference to this object.

PerformanceKit &UnsetTextHardwareAcceleration()

Removes the text hardware acceleration setting.

Returns:

A reference to this object.

virtual ~PerformanceKit()

Destroy this kit.

Public Static Functions

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

Returns:

A PerformanceKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PerformanceKit