|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.TransparencyControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the algorithms used for calculating transparency. Some algorithms, such as depth peeling, have additional attributes, and those are also controlled using this class.
Default values for the various fields of HPS.TransparencyControl can be found here.
◆ TransparencyControl() [1/2]
Initializes a control tied to the segment in_seg.
◆ TransparencyControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ ObjectType()
override HPS.Type HPS.TransparencyControl.ObjectType |
( |
| ) |
|
|
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.Control.
◆ SetAlgorithm()
Sets the algorithm to use when calculating transparency.
- Parameters
-
in_algorithm | The algorithm to use. |
- Returns
- a reference to this object.
◆ SetDepthPeelingLayers()
Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods.
- Parameters
-
in_layers | The number of layers to use when performing depth peeling. |
- Returns
- a reference to this object.
◆ SetDepthPeelingMinimumArea()
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.
◆ SetDepthPeelingPreference()
Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.
- Returns
- a reference to this object.
◆ SetDepthWriting()
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.
◆ SetMethod()
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.
◆ ShowAlgorithm()
Shows the algorithm to use when calculating transparency.
- Parameters
-
out_algorithm | The algorithm to use. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowDepthPeelingLayers()
bool HPS.TransparencyControl.ShowDepthPeelingLayers |
( |
out uint |
out_layers | ) |
|
|
inline |
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.
◆ ShowDepthPeelingMinimumArea()
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.
◆ ShowDepthPeelingPreference()
Shows the depth peeling preference.
- Parameters
-
out_preference | Whether quality of performance should be favored when performing depth peeling. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowDepthWriting()
bool HPS.TransparencyControl.ShowDepthWriting |
( |
out bool |
out_state | ) |
|
|
inline |
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.
◆ ShowMethod()
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.
◆ Type()
override HPS.Type HPS.TransparencyControl.Type |
( |
| ) |
|
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ UnsetAlgorithm()
Removes the transparency algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetDepthPeelingLayers()
Removes the depth peeling layers setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetDepthPeelingMinimumArea()
Removes the depth peeling minimum area setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetDepthPeelingPreference()
Removes the depth peeling preference setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetDepthWriting()
Removes the depth writing setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
◆ UnsetMethod()
Removes the transparency method setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by TransparencyKit.GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TransparencyControl.cs