
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.TransparencyKit in_kit) |
Check if the source TransparencyKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.TransparencyKit in_kit) |
Copies all settings from the source TransparencyKit into this object. More... | |
HPS.TransparencyKit | SetAlgorithm (HPS.Transparency.Algorithm in_algorithm) |
Sets the algorithm to use when calculating transparency. More... | |
HPS.TransparencyKit | SetDepthPeelingLayers (uint in_layers) |
Sets the number of layers to use when performing depth peeling. Ignored in other transparency methods. More... | |
HPS.TransparencyKit | SetDepthPeelingMinimumArea (float in_area, HPS.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. More... | |
HPS.TransparencyKit | SetDepthPeelingPreference (HPS.Transparency.Preference in_preference) |
Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods. More... | |
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. More... | |
HPS.TransparencyKit | SetMethod (HPS.Transparency.Method in_style) |
Sets the method to use when blending transparent geometry. More... | |
void | Show (out HPS.TransparencyKit out_kit) |
Copies all settings from this TransparencyKit into the given TransparencyKit. More... | |
bool | ShowAlgorithm (out HPS.Transparency.Algorithm out_algorithm) |
Shows the algorithm to use when calculating transparency. More... | |
bool | ShowDepthPeelingLayers (out uint out_layers) |
Shows the number of layers to use when performing depth peeling. More... | |
bool | ShowDepthPeelingMinimumArea (out float out_area, out HPS.Transparency.AreaUnits out_units) |
Shows the amount of the screen a layer needs to occupy in order to process another layer when performing depth peeling. More... | |
bool | ShowDepthPeelingPreference (out HPS.Transparency.Preference out_preference) |
Shows the depth peeling performance setting. More... | |
bool | ShowDepthWriting (out bool out_state) |
Shows whether transparent geometry should write into the Z-buffer. More... | |
bool | ShowMethod (out HPS.Transparency.Method out_style) |
Shows the method to use when blending transparent geometry. More... | |
TransparencyKit () | |
Initializes an empty kit. More... | |
TransparencyKit (HPS.TransparencyKit in_kit) | |
The copy constructor creates a new TransparencyKit object that contains the same settings as the source object. More... | |
HPS.TransparencyKit | UnsetAlgorithm () |
Removes the transparency algorithm setting. More... | |
HPS.TransparencyKit | UnsetDepthPeelingLayers () |
Removes the depth peeling layers setting. More... | |
HPS.TransparencyKit | UnsetDepthPeelingMinimumArea () |
Removes the depth peeling minimum area setting. More... | |
HPS.TransparencyKit | UnsetDepthPeelingPreference () |
Removes the depth peeling preference setting. More... | |
HPS.TransparencyKit | UnsetDepthWriting () |
Removes the depth writing setting. More... | |
HPS.TransparencyKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.TransparencyKit | UnsetMethod () |
Removes the transparency method setting. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
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. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.TransparencyKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.TransparencyKit a, HPS.TransparencyKit b) |
static bool | operator== (HPS.TransparencyKit a, HPS.TransparencyKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
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
|
inline |
Initializes an empty kit.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
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.
|
inline |
Check if the source TransparencyKit is equivalent to this object.
- Parameters
-
in_kit The source TransparencyKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Kit.
|
inline |
Copies all settings from the source TransparencyKit into this object.
- Parameters
-
in_kit The source TransparencyKit to copy.
|
inline |
Sets the algorithm to use when calculating transparency.
- Parameters
-
in_algorithm The algorithm to use.
- Returns
- a reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Specifies whether quality or performance should be favored when performing depth peeling. Ignored in other transparency methods.
- Returns
- a reference to this object.
|
inline |
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.
|
inline |
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.
|
inline |
Copies all settings from this TransparencyKit into the given TransparencyKit.
- Parameters
-
out_kit The TransparencyKit to populate with the contents of this object.
|
inline |
Shows the algorithm to use when calculating transparency.
- Parameters
-
out_algorithm The algorithm to use.
- Returns
- true if the setting is valid, false otherwise.
|
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.
|
inline |
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.
|
inline |
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.
|
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.
|
inline |
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.
|
inline |
Removes the transparency algorithm setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling layers setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling minimum area setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth peeling preference setting.
- Returns
- A reference to this object.
|
inline |
Removes the depth writing setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the transparency method setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.TransparencyKit.cs