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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.TextureOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.TextureOptionsKit in_kit)
 
HPS.TextureOptionsKit SetDecal (bool in_state)
 
HPS.TextureOptionsKit SetDecimationFilter (HPS.Material.Texture.Decimation in_filter)
 
HPS.TextureOptionsKit SetDownSampling (bool in_state)
 
HPS.TextureOptionsKit SetInterpolationFilter (HPS.Material.Texture.Interpolation in_filter)
 
HPS.TextureOptionsKit SetModulation (bool in_state)
 
HPS.TextureOptionsKit SetParameterizationSource (HPS.Material.Texture.Parameterization in_source)
 
HPS.TextureOptionsKit SetParameterOffset (ulong in_offset)
 
HPS.TextureOptionsKit SetTiling (HPS.Material.Texture.Tiling in_tiling)
 
HPS.TextureOptionsKit SetTransformMatrix (HPS.MatrixKit in_transform)
 
HPS.TextureOptionsKit SetValueScale (float in_min, float in_max)
 
void Show (out HPS.TextureOptionsKit out_kit)
 
bool ShowDecal (out bool out_state)
 
bool ShowDecimationFilter (out HPS.Material.Texture.Decimation out_filter)
 
bool ShowDownSampling (out bool out_state)
 
bool ShowInterpolationFilter (out HPS.Material.Texture.Interpolation out_filter)
 
bool ShowModulation (out bool out_state)
 
bool ShowParameterizationSource (out HPS.Material.Texture.Parameterization out_source)
 
bool ShowParameterOffset (out ulong out_offset)
 
bool ShowTiling (out HPS.Material.Texture.Tiling out_tiling)
 
bool ShowTransformMatrix (out HPS.MatrixKit out_transform)
 
bool ShowValueScale (out float out_min, out float out_max)
 
 TextureOptionsKit ()
 
 TextureOptionsKit (HPS.TextureOptionsKit in_kit)
 
HPS.TextureOptionsKit UnsetDecal ()
 
HPS.TextureOptionsKit UnsetDecimationFilter ()
 
HPS.TextureOptionsKit UnsetDownSampling ()
 
HPS.TextureOptionsKit UnsetEverything ()
 
HPS.TextureOptionsKit UnsetInterpolationFilter ()
 
HPS.TextureOptionsKit UnsetModulation ()
 
HPS.TextureOptionsKit UnsetParameterizationSource ()
 
HPS.TextureOptionsKit UnsetParameterOffset ()
 
HPS.TextureOptionsKit UnsetTiling ()
 
HPS.TextureOptionsKit UnsetTransformMatrix ()
 
HPS.TextureOptionsKit UnsetValueScale ()
 
- 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.TextureOptionsKit GetDefault ()
 
static bool operator!= (HPS.TextureOptionsKit a, HPS.TextureOptionsKit b)
 
static bool operator== (HPS.TextureOptionsKit a, HPS.TextureOptionsKit 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 TextureOptionsKit class is a user space object. It is used for setting texture options when defining textures or cube maps. Calling HPS.TextureOptionsKit.GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ TextureOptionsKit() [1/2]

HPS.TextureOptionsKit.TextureOptionsKit ( )
inline

The default constructor creates an empty TextureOptionsKit object.

◆ TextureOptionsKit() [2/2]

HPS.TextureOptionsKit.TextureOptionsKit ( HPS.TextureOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source TextureOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.TextureOptionsKit.Empty ( )
inlinevirtual

Indicates whether this TextureOptionsKit has any values set on it.

Returns
true if no values are set on this TextureOptionsKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.

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

◆ GetDefault()

static HPS.TextureOptionsKit HPS.TextureOptionsKit.GetDefault ( )
inlinestatic

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

◆ ObjectType()

override HPS.Type HPS.TextureOptionsKit.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.TextureOptionsKit.Set ( HPS.TextureOptionsKit  in_kit)
inline

Copies the source TextureOptionsKit into this TextureOptionsKit.

Parameters
in_kitThe source TextureOptionsKit to copy.

◆ SetDecal()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetDecal ( bool  in_state)
inline

Sets whether the texture should act as a decal, i.e., whether diffuse colors will be allowed through transparent portions of a diffuse texture. This only affects a diffuse texture on layer 0.

Parameters
in_stateWhether the texture should act as a decal.
Returns
A reference to this TextureOptionsKit.

◆ SetDecimationFilter()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetDecimationFilter ( HPS.Material.Texture.Decimation  in_filter)
inline

Sets the decimation filter to use for the texture.

Parameters
in_filterThe decimation filter to use for the texture.
Returns
A reference to this TextureOptionsKit.

◆ SetDownSampling()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetDownSampling ( bool  in_state)
inline

Sets whether the texture should be down-sampled.

Parameters
in_stateWhether the texture should be down-sampled.
Returns
A reference to this TextureOptionsKit.

◆ SetInterpolationFilter()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetInterpolationFilter ( HPS.Material.Texture.Interpolation  in_filter)
inline

Sets the interpolation filter to use for the texture.

Parameters
in_filterThe interpolation filter to use for the texture.
Returns
A reference to this TextureOptionsKit.

◆ SetModulation()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetModulation ( bool  in_state)
inline

Sets whether the texture should be modulated with materials from layers below it. This only applies to diffuse textures.

Parameters
in_stateWhether the texture should be modulated with materials from layers below it.
Returns
A reference to this TextureOptionsKit.

◆ SetParameterizationSource()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetParameterizationSource ( HPS.Material.Texture.Parameterization  in_source)
inline

Sets the parameterization source for the texture.

Parameters
in_sourceThe parameterization source for the texture.
Returns
A reference to this TextureOptionsKit.

◆ SetParameterOffset()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetParameterOffset ( ulong  in_offset)
inline

Sets the parameter offset for the texture, i.e., the offset into the texture parameter list to use at each vertex to locate the parameters for the texture.

Parameters
in_offsetThe parameter offset for the texture.
Returns
A reference to this TextureOptionsKit.

◆ SetTiling()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetTiling ( HPS.Material.Texture.Tiling  in_tiling)
inline

Sets how the texture will be tiled for parameters outside the range [0, 1].

Parameters
in_tilingHow the texture will be tiled for parameters outside the range [0, 1].
Returns
A reference to this TextureOptionsKit.

◆ SetTransformMatrix()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetTransformMatrix ( HPS.MatrixKit  in_transform)
inline

Sets the transform matrix to use for the texture.

Parameters
in_transformThe transform matrix to use for the texture.
Returns
A reference to this TextureOptionsKit.

◆ SetValueScale()

HPS.TextureOptionsKit HPS.TextureOptionsKit.SetValueScale ( float  in_min,
float  in_max 
)
inline

Sets the value scaling (linear remapping) of texture element values.

Parameters
in_minThe value to which zero will be remapped.
in_maxThe value to which one will be remapped.
Returns
A reference to this TextureOptionsKit.

◆ Show()

void HPS.TextureOptionsKit.Show ( out HPS.TextureOptionsKit  out_kit)
inline

Copies this TextureOptionsKit into the given TextureOptionsKit.

Parameters
out_kitThe TextureOptionsKit to populate with the contents of this TextureOptionsKit.

◆ ShowDecal()

bool HPS.TextureOptionsKit.ShowDecal ( out bool  out_state)
inline

Shows whether the texture should act as a decal.

Parameters
out_stateWhether the texture should act as a decal.
Returns
true if the flag is valid, false otherwise.

◆ ShowDecimationFilter()

bool HPS.TextureOptionsKit.ShowDecimationFilter ( out HPS.Material.Texture.Decimation  out_filter)
inline

Shows the decimation filter for the texture.

Parameters
out_filterThe decimation filter for the texture.
Returns
true if the filter is valid, false otherwise.

◆ ShowDownSampling()

bool HPS.TextureOptionsKit.ShowDownSampling ( out bool  out_state)
inline

Shows whether the texture should be down-sampled.

Parameters
out_stateWhether the texture should be down-sampled.
Returns
true if the flag is valid, false otherwise.

◆ ShowInterpolationFilter()

bool HPS.TextureOptionsKit.ShowInterpolationFilter ( out HPS.Material.Texture.Interpolation  out_filter)
inline

Shows the interpolation filter for the texture.

Parameters
out_filterThe interpolation filter for the texture.
Returns
true if the filter is valid, false otherwise.

◆ ShowModulation()

bool HPS.TextureOptionsKit.ShowModulation ( out bool  out_state)
inline

Shows whether the texture should be modulated with materials from layers below it.

Parameters
out_stateWhether the texture should be be modulated with materials from layers below it.
Returns
true if the flag is valid, false otherwise.

◆ ShowParameterizationSource()

bool HPS.TextureOptionsKit.ShowParameterizationSource ( out HPS.Material.Texture.Parameterization  out_source)
inline

Shows the parameterization source for the texture.

Parameters
out_sourceThe parametererization source for the texture.
Returns
true if the parameterization source is valid, false otherwise.

◆ ShowParameterOffset()

bool HPS.TextureOptionsKit.ShowParameterOffset ( out ulong  out_offset)
inline

Shows the parameter offset for the texture.

Parameters
out_offsetThe parameter offset for the texture.
Returns
true if the offset is valid, false otherwise.

◆ ShowTiling()

bool HPS.TextureOptionsKit.ShowTiling ( out HPS.Material.Texture.Tiling  out_tiling)
inline

Shows how the texture will be tiled for parameters outside the range [0, 1].

Parameters
out_tilingHow the texture will be tiled for parameters outside the range [0, 1].
Returns
true if the tiling is valid, false otherwise.

◆ ShowTransformMatrix()

bool HPS.TextureOptionsKit.ShowTransformMatrix ( out HPS.MatrixKit  out_transform)
inline

Shows the transform matrix for the texture.

Parameters
out_transformThe transform matrix for the texture.
Returns
true if the transform matrix is valid, false otherwise.

◆ ShowValueScale()

bool HPS.TextureOptionsKit.ShowValueScale ( out float  out_min,
out float  out_max 
)
inline

Shows the value scale for the texture.

Parameters
out_minThe value to which zero will be remapped.
out_maxThe value to which one will be remapped.
Returns
true if the filter is valid, false otherwise.

◆ UnsetDecal()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDecal ( )
inline

Removes whether the texture should act as a decal.

Returns
A reference to this TextureOptionsKit.

◆ UnsetDecimationFilter()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDecimationFilter ( )
inline

Removes the decimation filter for the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetDownSampling()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDownSampling ( )
inline

Removes whether to down-sample the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetEverything()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetEverything ( )
inline

Removes all settings from this TextureOptionsKit.

Returns
A reference to this TextureOptionsKit.

◆ UnsetInterpolationFilter()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetInterpolationFilter ( )
inline

Removes the interpolation filter for the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetModulation()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetModulation ( )
inline

Removes whether the texture should modulate with materials from layers below it.

Returns
A reference to this TextureOptionsKit.

◆ UnsetParameterizationSource()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetParameterizationSource ( )
inline

Removes the parameter source for the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetParameterOffset()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetParameterOffset ( )
inline

Removes the parameter offset for the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetTiling()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetTiling ( )
inline

Removes how the texture will be tiled for parameters outside the range [0, 1].

Returns
A reference to this TextureOptionsKit.

◆ UnsetTransformMatrix()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetTransformMatrix ( )
inline

Removes the transform matrix for the texture.

Returns
A reference to this TextureOptionsKit.

◆ UnsetValueScale()

HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetValueScale ( )
inline

Removes the value scale for the texture.

Returns
A reference to this TextureOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.TextureOptionsKit.cs