#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::TransparencyKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
HPS::TransparencyKit::TransparencyKit |
( |
| ) |
|
Initializes an empty kit.
The copy constructor creates a new TransparencyKit object that contains the same settings as the source object.
- Parameters
-
in_kit | The source object to copy. |
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
-
virtual HPS::TransparencyKit::~TransparencyKit |
( |
| ) |
|
|
virtual |
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.
Check if the source TransparencyKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
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.
bool HPS::TransparencyKit::operator!= |
( |
TransparencyKit const & |
in_kit | ) |
const |
Check if the source TransparencyKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this TransparencyKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this TransparencyKit.
Copies the source TransparencyKit into this object.
- Parameters
-
- Returns
- A reference to this object.
bool HPS::TransparencyKit::operator== |
( |
TransparencyKit const & |
in_kit | ) |
const |
Check if the source TransparencyKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
Copies all settings from the source TransparencyKit into this object.
- Parameters
-
Sets the algorithm to use when calculating transparency.
- Parameters
-
in_algorithm | The algorithm to use. |
- Returns
- a reference to this object.
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_layers | The number of layers to use when performing depth peeling. |
- Returns
- a reference to this object.
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_area | The amount of the screen a layer needs to occupy in order to process another layer. |
in_units | The units of the minimum area. |
- Returns
- a reference to this object.
Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.
- Parameters
-
in_perference | The desired preference setting. |
- Returns
- a reference to this object.
Controls whether transparent geometry should write into the Z-buffer. Applies only when the transparency algorithm is NoSorting, ZSortNicest, or ZSortFastest.
- Parameters
-
in_state | Whether transparent geometry should write into the Z-buffer. |
- Returns
- a reference to this object.
Sets the method to use when blending transparent geometry.
- Parameters
-
in_style | The method to use when blending transparent geometry. |
- Returns
- a reference to this object.
Shows the algorithm to use when calculating transparency.
- Parameters
-
out_algorithm | The algorithm to use. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS::TransparencyKit::ShowDepthPeelingLayers |
( |
unsigned int & |
out_layers | ) |
const |
Shows the number of layers to use when performing depth peeling.
- Parameters
-
out_layers | The number of layers to use when performing depth peeling. |
- Returns
- true if the setting is valid, false otherwise.
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_area | The amount of the screen a layer needs to occupy in order to process another layer. |
out_units | The units of the minimum area. |
- Returns
- true if the setting is valid, false otherwise.
Shows the depth peeling performance setting.
- Parameters
-
out_preference | Whether quality or performance should be favored when performing depth peeling. |
- Returns
- true if the setting is valid, false otherwise.
bool HPS::TransparencyKit::ShowDepthWriting |
( |
bool & |
out_state | ) |
const |
Shows whether transparent geometry should write into the Z-buffer.
- Parameters
-
out_state | Whether transparent geometry should write into the Z-buffer. |
- Returns
- true if the setting is valid, false otherwise.
Shows the method to use when blending transparent geometry.
- Parameters
-
out_style | The method to use when blending transparent geometry. |
- Returns
- true if the setting is valid, false otherwise.
Removes the transparency algorithm setting.
- Returns
- A reference to this object.
Removes the depth peeling layers setting.
- Returns
- A reference to this object.
Removes the depth peeling minimum area setting.
- Returns
- A reference to this object.
Removes the depth peeling preference setting.
- Returns
- A reference to this object.
Removes the depth writing setting.
- Returns
- A reference to this object.
Removes all settings from this object.
- Returns
- A reference to this object.
Removes the transparency method setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: