#include <hps.h>

Inheritance diagram for HPS::PerformanceKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (PerformanceKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (PerformanceKit const &in_kit) const
 
PerformanceKitoperator= (PerformanceKit &&in_that)
 
PerformanceKitoperator= (PerformanceKit const &in_kit)
 
bool operator== (PerformanceKit const &in_kit) const
 
 PerformanceKit ()
 
 PerformanceKit (PerformanceKit const &in_kit)
 
 PerformanceKit (PerformanceKit &&in_that)
 
void Set (PerformanceKit const &in_kit)
 
PerformanceKitSetDisplayLists (Performance::DisplayLists in_display_list=Performance::DisplayLists::Segment)
 
PerformanceKitSetStaticConditions (Performance::StaticConditions in_conditions)
 
PerformanceKitSetStaticModel (Performance::StaticModel in_model_type)
 
PerformanceKitSetTextHardwareAcceleration (bool in_state)
 
void Show (PerformanceKit &out_kit) const
 
bool ShowDisplayLists (Performance::DisplayLists &out_display_list) const
 
bool ShowStaticConditions (Performance::StaticConditions &out_conditions) const
 
bool ShowStaticModel (Performance::StaticModel &out_model_type) const
 
bool ShowTextHardwareAcceleration (bool &out_state) const
 
PerformanceKitUnsetDisplayLists ()
 
PerformanceKitUnsetEverything ()
 
PerformanceKitUnsetStaticConditions ()
 
PerformanceKitUnsetStaticModel ()
 
PerformanceKitUnsetTextHardwareAcceleration ()
 
virtual ~PerformanceKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static PerformanceKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PerformanceKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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

◆ PerformanceKit() [1/3]

HPS::PerformanceKit::PerformanceKit ( )

Initializes an empty kit.

◆ PerformanceKit() [2/3]

HPS::PerformanceKit::PerformanceKit ( PerformanceKit const &  in_kit)

The copy constructor creates a new PerformanceKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

◆ PerformanceKit() [3/3]

HPS::PerformanceKit::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_thatAn rvalue reference to a PerformanceKit to take the impl from.

◆ ~PerformanceKit()

virtual HPS::PerformanceKit::~PerformanceKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ 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
in_kitThe source PerformanceKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static PerformanceKit HPS::PerformanceKit::GetDefault ( )
static

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
in_kitThe source PerformanceKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

PerformanceKit& HPS::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_thatAn rvalue reference to a PerformanceKit to take the impl from.
Returns
A reference to this PerformanceKit.

◆ operator=() [2/2]

PerformanceKit& HPS::PerformanceKit::operator= ( PerformanceKit const &  in_kit)

Copies the source PerformanceKit into this object.

Parameters
in_kitThe source PerformanceKit to copy.
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
in_kitThe source PerformanceKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::PerformanceKit::Set ( PerformanceKit const &  in_kit)

Copies the source PerformanceKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetDisplayLists()

PerformanceKit& HPS::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_listThe type of display lists, if any, that should be used.
Returns
A reference to this object.

◆ SetStaticConditions()

PerformanceKit& HPS::PerformanceKit::SetStaticConditions ( Performance::StaticConditions  in_conditions)

Sets the static conditions handling mode

Parameters
in_conditionsThe type of handling that should be used.
Returns
A reference to this object.

◆ SetStaticModel()

PerformanceKit& HPS::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_typeThe type of static tree, if any, that should be used.
Returns
A reference to this object.

◆ SetTextHardwareAcceleration()

PerformanceKit& HPS::PerformanceKit::SetTextHardwareAcceleration ( bool  in_state)

Sets text hardware acceleration. Transformable text may be included if segment-level display lists are active.

Parameters
in_stateWhether to include transformable text in segment-level display lists
Returns
A reference to this object.

◆ Show()

void HPS::PerformanceKit::Show ( PerformanceKit out_kit) const

Copies this object into the given PerformanceKit.

Parameters
out_kitThe PerformanceKit to populate with the contents of this object.

◆ ShowDisplayLists()

bool HPS::PerformanceKit::ShowDisplayLists ( Performance::DisplayLists out_display_list) const

Shows the display list state.

Parameters
out_display_listThe type of display lists, if any.
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticConditions()

bool HPS::PerformanceKit::ShowStaticConditions ( Performance::StaticConditions out_conditions) const

Shows the static conditions handling state.

Parameters
out_conditionsThe type of static condition handline
Returns
true if the setting is valid, false otherwise.

◆ ShowStaticModel()

bool HPS::PerformanceKit::ShowStaticModel ( Performance::StaticModel out_model_type) const

Shows the static model state.

Parameters
out_model_typeThe type of static tree, if any
Returns
true if the setting is valid, false otherwise.

◆ ShowTextHardwareAcceleration()

bool HPS::PerformanceKit::ShowTextHardwareAcceleration ( bool &  out_state) const

Shows the text hardware acceleration state.

Parameters
out_stateThe text hardware acceleration setting, if any.
Returns
true if the setting is valid, false otherwise.

◆ UnsetDisplayLists()

PerformanceKit& HPS::PerformanceKit::UnsetDisplayLists ( )

Removes the display list setting.

Returns
A reference to this object.

◆ UnsetEverything()

PerformanceKit& HPS::PerformanceKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetStaticConditions()

PerformanceKit& HPS::PerformanceKit::UnsetStaticConditions ( )

Removes the static condition handling state

Returns
A reference to this object.

◆ UnsetStaticModel()

PerformanceKit& HPS::PerformanceKit::UnsetStaticModel ( )

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

Returns
A reference to this object.

◆ UnsetTextHardwareAcceleration()

PerformanceKit& HPS::PerformanceKit::UnsetTextHardwareAcceleration ( )

Removes the text hardware acceleration setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: