#include <hps.h>

Inheritance diagram for HPS::TransparencyKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (TransparencyKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (TransparencyKit const &in_kit) const
 
TransparencyKitoperator= (TransparencyKit &&in_that)
 
TransparencyKitoperator= (TransparencyKit const &in_kit)
 
bool operator== (TransparencyKit const &in_kit) const
 
void Set (TransparencyKit const &in_kit)
 
TransparencyKitSetAlgorithm (Transparency::Algorithm in_algorithm)
 
TransparencyKitSetDepthPeelingLayers (unsigned int in_layers)
 
TransparencyKitSetDepthPeelingMinimumArea (float in_area, Transparency::AreaUnits in_units)
 
TransparencyKitSetDepthPeelingPreference (Transparency::Preference in_preference)
 
TransparencyKitSetDepthWriting (bool in_state)
 
TransparencyKitSetMethod (Transparency::Method in_style)
 
void Show (TransparencyKit &out_kit) const
 
bool ShowAlgorithm (Transparency::Algorithm &out_algorithm) const
 
bool ShowDepthPeelingLayers (unsigned int &out_layers) const
 
bool ShowDepthPeelingMinimumArea (float &out_area, Transparency::AreaUnits &out_units) const
 
bool ShowDepthPeelingPreference (Transparency::Preference &out_preference) const
 
bool ShowDepthWriting (bool &out_state) const
 
bool ShowMethod (Transparency::Method &out_style) const
 
 TransparencyKit ()
 
 TransparencyKit (TransparencyKit const &in_kit)
 
 TransparencyKit (TransparencyKit &&in_that)
 
TransparencyKitUnsetAlgorithm ()
 
TransparencyKitUnsetDepthPeelingLayers ()
 
TransparencyKitUnsetDepthPeelingMinimumArea ()
 
TransparencyKitUnsetDepthPeelingPreference ()
 
TransparencyKitUnsetDepthWriting ()
 
TransparencyKitUnsetEverything ()
 
TransparencyKitUnsetMethod ()
 
virtual ~TransparencyKit ()
 
- 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 TransparencyKit 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::TransparencyKit
 
- 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::TransparencyKit class is a user space object, useful for carrying a group of attribute settings related to transparency. Calling HPS::TransparencyKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ TransparencyKit() [1/3]

HPS::TransparencyKit::TransparencyKit ( )

Initializes an empty kit.

◆ TransparencyKit() [2/3]

HPS::TransparencyKit::TransparencyKit ( TransparencyKit const &  in_kit)

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

Parameters
in_kitThe source object to copy.

◆ TransparencyKit() [3/3]

HPS::TransparencyKit::TransparencyKit ( TransparencyKit &&  in_that)

The move constructor creates a TransparencyKit by transferring the underlying impl of the rvalue reference to this TransparencyKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a TransparencyKit to take the impl from.

◆ ~TransparencyKit()

virtual HPS::TransparencyKit::~TransparencyKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::TransparencyKit::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::TransparencyKit::Equals ( TransparencyKit const &  in_kit) const

Check if the source TransparencyKit is equivalent to this object.

Parameters
in_kitThe source TransparencyKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static TransparencyKit HPS::TransparencyKit::GetDefault ( )
static

Creates a TransparencyKit 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 TransparencyKit with the default settings.

◆ ObjectType()

HPS::Type HPS::TransparencyKit::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::TransparencyKit::operator!= ( TransparencyKit const &  in_kit) const

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

Parameters
in_kitThe source TransparencyKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

TransparencyKit& HPS::TransparencyKit::operator= ( TransparencyKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an TransparencyKit to take the impl from.
Returns
A reference to this TransparencyKit.

◆ operator=() [2/2]

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

Copies the source TransparencyKit into this object.

Parameters
in_kitThe source TransparencyKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::TransparencyKit::operator== ( TransparencyKit const &  in_kit) const

Check if the source TransparencyKit is equivalent to this object.

Parameters
in_kitThe source TransparencyKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies all settings from the source TransparencyKit into this object.

Parameters
in_kitThe source TransparencyKit to copy.

◆ SetAlgorithm()

TransparencyKit& HPS::TransparencyKit::SetAlgorithm ( Transparency::Algorithm  in_algorithm)

Sets the algorithm to use when calculating transparency.

Parameters
in_algorithmThe algorithm to use.
Returns
a reference to this object.

◆ SetDepthPeelingLayers()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingLayers ( unsigned int  in_layers)

Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods.

Warning
This setting will be limited by the depth peeling layer count set at the containing window / subwindow. If the count is lower than the containing window's count, excess render passes will be omitted.
Parameters
in_layersThe number of layers to use when performing depth peeling.
Returns
a reference to this object.

◆ SetDepthPeelingMinimumArea()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingMinimumArea ( float  in_area,
Transparency::AreaUnits  in_units 
)

Sets the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling. Ignored in other transparency methods.

Parameters
in_areaThe amount of the screen a layer needs to occupy in order to process another layer.
in_unitsThe units of the minimum area.
Returns
a reference to this object.

◆ SetDepthPeelingPreference()

TransparencyKit& HPS::TransparencyKit::SetDepthPeelingPreference ( Transparency::Preference  in_preference)

Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.

Parameters
in_perferenceThe desired preference setting.
Returns
a reference to this object.

◆ SetDepthWriting()

TransparencyKit& HPS::TransparencyKit::SetDepthWriting ( bool  in_state)

Controls whether transparent geometry should write into the Z-buffer. Applies only when the transparency algorithm is NoSorting, ZSortNicest, or ZSortFastest.

Parameters
in_stateWhether transparent geometry should write into the Z-buffer.
Returns
a reference to this object.

◆ SetMethod()

TransparencyKit& HPS::TransparencyKit::SetMethod ( Transparency::Method  in_style)

Sets the method to use when blending transparent geometry.

Parameters
in_styleThe method to use when blending transparent geometry.
Returns
a reference to this object.

◆ Show()

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

Copies all settings from this TransparencyKit into the given TransparencyKit.

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

◆ ShowAlgorithm()

bool HPS::TransparencyKit::ShowAlgorithm ( Transparency::Algorithm out_algorithm) const

Shows the algorithm to use when calculating transparency.

Parameters
out_algorithmThe algorithm to use.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingLayers()

bool HPS::TransparencyKit::ShowDepthPeelingLayers ( unsigned int &  out_layers) const

Shows the number of layers to use when performing depth peeling.

Parameters
out_layersThe number of layers to use when performing depth peeling.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingMinimumArea()

bool HPS::TransparencyKit::ShowDepthPeelingMinimumArea ( float &  out_area,
Transparency::AreaUnits out_units 
) const

Shows the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling.

Parameters
out_areaThe amount of the screen a layer needs to occupy in order to process another layer.
out_unitsThe units of the minimum area.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthPeelingPreference()

bool HPS::TransparencyKit::ShowDepthPeelingPreference ( Transparency::Preference out_preference) const

Shows the depth peeling performance setting.

Parameters
out_preferenceWhether quality or performance should be favored when performing depth peeling.
Returns
true if the setting is valid, false otherwise.

◆ ShowDepthWriting()

bool HPS::TransparencyKit::ShowDepthWriting ( bool &  out_state) const

Shows whether transparent geometry should write into the Z-buffer.

Parameters
out_stateWhether transparent geometry should write into the Z-buffer.
Returns
true if the setting is valid, false otherwise.

◆ ShowMethod()

bool HPS::TransparencyKit::ShowMethod ( Transparency::Method out_style) const

Shows the method to use when blending transparent geometry.

Parameters
out_styleThe method to use when blending transparent geometry.
Returns
true if the setting is valid, false otherwise.

◆ UnsetAlgorithm()

TransparencyKit& HPS::TransparencyKit::UnsetAlgorithm ( )

Removes the transparency algorithm setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingLayers()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingLayers ( )

Removes the depth peeling layers setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingMinimumArea()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingMinimumArea ( )

Removes the depth peeling minimum area setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingPreference()

TransparencyKit& HPS::TransparencyKit::UnsetDepthPeelingPreference ( )

Removes the depth peeling preference setting.

Returns
A reference to this object.

◆ UnsetDepthWriting()

TransparencyKit& HPS::TransparencyKit::UnsetDepthWriting ( )

Removes the depth writing setting.

Returns
A reference to this object.

◆ UnsetEverything()

TransparencyKit& HPS::TransparencyKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMethod()

TransparencyKit& HPS::TransparencyKit::UnsetMethod ( )

Removes the transparency method setting.

Returns
A reference to this object.

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