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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TransparencyKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.TransparencyKit in_kit)
 
HPS.TransparencyKit SetAlgorithm (HPS.Transparency.Algorithm in_algorithm)
 
HPS.TransparencyKit SetDepthPeelingLayers (uint in_layers)
 
HPS.TransparencyKit SetDepthPeelingMinimumArea (float in_area, HPS.Transparency.AreaUnits in_units)
 
HPS.TransparencyKit SetDepthPeelingPreference (HPS.Transparency.Preference in_preference)
 
HPS.TransparencyKit SetDepthWriting (bool in_state)
 
HPS.TransparencyKit SetMethod (HPS.Transparency.Method in_style)
 
void Show (out HPS.TransparencyKit out_kit)
 
bool ShowAlgorithm (out HPS.Transparency.Algorithm out_algorithm)
 
bool ShowDepthPeelingLayers (out uint out_layers)
 
bool ShowDepthPeelingMinimumArea (out float out_area, out HPS.Transparency.AreaUnits out_units)
 
bool ShowDepthPeelingPreference (out HPS.Transparency.Preference out_preference)
 
bool ShowDepthWriting (out bool out_state)
 
bool ShowMethod (out HPS.Transparency.Method out_style)
 
 TransparencyKit ()
 
 TransparencyKit (HPS.TransparencyKit in_kit)
 
HPS.TransparencyKit UnsetAlgorithm ()
 
HPS.TransparencyKit UnsetDepthPeelingLayers ()
 
HPS.TransparencyKit UnsetDepthPeelingMinimumArea ()
 
HPS.TransparencyKit UnsetDepthPeelingPreference ()
 
HPS.TransparencyKit UnsetDepthWriting ()
 
HPS.TransparencyKit UnsetEverything ()
 
HPS.TransparencyKit UnsetMethod ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.TransparencyKit GetDefault ()
 
static bool operator!= (HPS.TransparencyKit a, HPS.TransparencyKit b)
 
static bool operator== (HPS.TransparencyKit a, HPS.TransparencyKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ TransparencyKit() [1/2]

HPS.TransparencyKit.TransparencyKit ( )
inline

Initializes an empty kit.

◆ TransparencyKit() [2/2]

HPS.TransparencyKit.TransparencyKit ( HPS.TransparencyKit  in_kit)
inline

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

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.TransparencyKit.Empty ( )
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.

◆ Equals()

bool HPS.TransparencyKit.Equals ( HPS.TransparencyKit  in_kit)
inline

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 HPS.TransparencyKit HPS.TransparencyKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.TransparencyKit.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.Kit.

◆ Set()

void HPS.TransparencyKit.Set ( HPS.TransparencyKit  in_kit)
inline

Copies all settings from the source TransparencyKit into this object.

Parameters
in_kitThe source TransparencyKit to copy.

◆ SetAlgorithm()

HPS.TransparencyKit HPS.TransparencyKit.SetAlgorithm ( HPS.Transparency.Algorithm  in_algorithm)
inline

Sets the algorithm to use when calculating transparency.

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

◆ SetDepthPeelingLayers()

HPS.TransparencyKit HPS.TransparencyKit.SetDepthPeelingLayers ( uint  in_layers)
inline

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()

HPS.TransparencyKit HPS.TransparencyKit.SetDepthPeelingMinimumArea ( float  in_area,
HPS.Transparency.AreaUnits  in_units 
)
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_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()

HPS.TransparencyKit HPS.TransparencyKit.SetDepthPeelingPreference ( HPS.Transparency.Preference  in_preference)
inline

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

Returns
a reference to this object.

◆ SetDepthWriting()

HPS.TransparencyKit HPS.TransparencyKit.SetDepthWriting ( bool  in_state)
inline

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()

HPS.TransparencyKit HPS.TransparencyKit.SetMethod ( HPS.Transparency.Method  in_style)
inline

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 ( out HPS.TransparencyKit  out_kit)
inline

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 ( out HPS.Transparency.Algorithm  out_algorithm)
inline

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 ( out uint  out_layers)
inline

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 ( out float  out_area,
out HPS.Transparency.AreaUnits  out_units 
)
inline

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 ( out HPS.Transparency.Preference  out_preference)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Transparency.Method  out_style)
inline

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()

HPS.TransparencyKit HPS.TransparencyKit.UnsetAlgorithm ( )
inline

Removes the transparency algorithm setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingLayers()

HPS.TransparencyKit HPS.TransparencyKit.UnsetDepthPeelingLayers ( )
inline

Removes the depth peeling layers setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingMinimumArea()

HPS.TransparencyKit HPS.TransparencyKit.UnsetDepthPeelingMinimumArea ( )
inline

Removes the depth peeling minimum area setting.

Returns
A reference to this object.

◆ UnsetDepthPeelingPreference()

HPS.TransparencyKit HPS.TransparencyKit.UnsetDepthPeelingPreference ( )
inline

Removes the depth peeling preference setting.

Returns
A reference to this object.

◆ UnsetDepthWriting()

HPS.TransparencyKit HPS.TransparencyKit.UnsetDepthWriting ( )
inline

Removes the depth writing setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.TransparencyKit HPS.TransparencyKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMethod()

HPS.TransparencyKit HPS.TransparencyKit.UnsetMethod ( )
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