
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this TextureOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.TextureOptionsKit in_kit) |
Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.TextureOptionsKit in_kit) |
Copies the source TextureOptionsKit into this TextureOptionsKit. More... | |
HPS.TextureOptionsKit | SetDecal (bool in_state) |
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. More... | |
HPS.TextureOptionsKit | SetDecimationFilter (HPS.Material.Texture.Decimation in_filter) |
Sets the decimation filter to use for the texture. More... | |
HPS.TextureOptionsKit | SetDownSampling (bool in_state) |
Sets whether the texture should be down-sampled. More... | |
HPS.TextureOptionsKit | SetInterpolationFilter (HPS.Material.Texture.Interpolation in_filter) |
Sets the interpolation filter to use for the texture. More... | |
HPS.TextureOptionsKit | SetModulation (bool in_state) |
Sets whether the texture should be modulated with materials from layers below it. This only applies to diffuse textures. More... | |
HPS.TextureOptionsKit | SetParameterizationSource (HPS.Material.Texture.Parameterization in_source) |
Sets the parameterization source for the texture. More... | |
HPS.TextureOptionsKit | SetParameterOffset (ulong in_offset) |
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. More... | |
HPS.TextureOptionsKit | SetTiling (HPS.Material.Texture.Tiling in_tiling) |
Sets how the texture will be tiled for parameters outside the range [0, 1]. More... | |
HPS.TextureOptionsKit | SetTransformMatrix (HPS.MatrixKit in_transform) |
Sets the transform matrix to use for the texture. More... | |
HPS.TextureOptionsKit | SetValueScale (float in_min, float in_max) |
Sets the value scaling (linear remapping) of texture element values. More... | |
void | Show (out HPS.TextureOptionsKit out_kit) |
Copies this TextureOptionsKit into the given TextureOptionsKit. More... | |
bool | ShowDecal (out bool out_state) |
Shows whether the texture should act as a decal. More... | |
bool | ShowDecimationFilter (out HPS.Material.Texture.Decimation out_filter) |
Shows the decimation filter for the texture. More... | |
bool | ShowDownSampling (out bool out_state) |
Shows whether the texture should be down-sampled. More... | |
bool | ShowInterpolationFilter (out HPS.Material.Texture.Interpolation out_filter) |
Shows the interpolation filter for the texture. More... | |
bool | ShowModulation (out bool out_state) |
Shows whether the texture should be modulated with materials from layers below it. More... | |
bool | ShowParameterizationSource (out HPS.Material.Texture.Parameterization out_source) |
Shows the parameterization source for the texture. More... | |
bool | ShowParameterOffset (out ulong out_offset) |
Shows the parameter offset for the texture. More... | |
bool | ShowTiling (out HPS.Material.Texture.Tiling out_tiling) |
Shows how the texture will be tiled for parameters outside the range [0, 1]. More... | |
bool | ShowTransformMatrix (out HPS.MatrixKit out_transform) |
Shows the transform matrix for the texture. More... | |
bool | ShowValueScale (out float out_min, out float out_max) |
Shows the value scale for the texture. More... | |
TextureOptionsKit () | |
The default constructor creates an empty TextureOptionsKit object. More... | |
TextureOptionsKit (HPS.TextureOptionsKit in_kit) | |
The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit. More... | |
HPS.TextureOptionsKit | UnsetDecal () |
Removes whether the texture should act as a decal. More... | |
HPS.TextureOptionsKit | UnsetDecimationFilter () |
Removes the decimation filter for the texture. More... | |
HPS.TextureOptionsKit | UnsetDownSampling () |
Removes whether to down-sample the texture. More... | |
HPS.TextureOptionsKit | UnsetEverything () |
Removes all settings from this TextureOptionsKit. More... | |
HPS.TextureOptionsKit | UnsetInterpolationFilter () |
Removes the interpolation filter for the texture. More... | |
HPS.TextureOptionsKit | UnsetModulation () |
Removes whether the texture should modulate with materials from layers below it. More... | |
HPS.TextureOptionsKit | UnsetParameterizationSource () |
Removes the parameter source for the texture. More... | |
HPS.TextureOptionsKit | UnsetParameterOffset () |
Removes the parameter offset for the texture. More... | |
HPS.TextureOptionsKit | UnsetTiling () |
Removes how the texture will be tiled for parameters outside the range [0, 1]. More... | |
HPS.TextureOptionsKit | UnsetTransformMatrix () |
Removes the transform matrix for the texture. More... | |
HPS.TextureOptionsKit | UnsetValueScale () |
Removes the value scale for the texture. 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.TextureOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.TextureOptionsKit a, HPS.TextureOptionsKit b) |
static bool | operator== (HPS.TextureOptionsKit a, HPS.TextureOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
The default constructor creates an empty TextureOptionsKit object.
|
inline |
The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to compare to this TextureOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
inline |
Copies the source TextureOptionsKit into this TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to copy.
|
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_state Whether the texture should act as a decal.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets the decimation filter to use for the texture.
- Parameters
-
in_filter The decimation filter to use for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets whether the texture should be down-sampled.
- Parameters
-
in_state Whether the texture should be down-sampled.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets the interpolation filter to use for the texture.
- Parameters
-
in_filter The interpolation filter to use for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets whether the texture should be modulated with materials from layers below it. This only applies to diffuse textures.
- Parameters
-
in_state Whether the texture should be modulated with materials from layers below it.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets the parameterization source for the texture.
- Parameters
-
in_source The parameterization source for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
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_offset The parameter offset for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets how the texture will be tiled for parameters outside the range [0, 1].
- Parameters
-
in_tiling How the texture will be tiled for parameters outside the range [0, 1].
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets the transform matrix to use for the texture.
- Parameters
-
in_transform The transform matrix to use for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Sets the value scaling (linear remapping) of texture element values.
- Parameters
-
in_min The value to which zero will be remapped. in_max The value to which one will be remapped.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Copies this TextureOptionsKit into the given TextureOptionsKit.
- Parameters
-
out_kit The TextureOptionsKit to populate with the contents of this TextureOptionsKit.
|
inline |
Shows whether the texture should act as a decal.
- Parameters
-
out_state Whether the texture should act as a decal.
- Returns
- true if the flag is valid, false otherwise.
|
inline |
Shows the decimation filter for the texture.
- Parameters
-
out_filter The decimation filter for the texture.
- Returns
- true if the filter is valid, false otherwise.
|
inline |
Shows whether the texture should be down-sampled.
- Parameters
-
out_state Whether the texture should be down-sampled.
- Returns
- true if the flag is valid, false otherwise.
|
inline |
Shows the interpolation filter for the texture.
- Parameters
-
out_filter The interpolation filter for the texture.
- Returns
- true if the filter is valid, false otherwise.
|
inline |
Shows whether the texture should be modulated with materials from layers below it.
- Parameters
-
out_state Whether the texture should be be modulated with materials from layers below it.
- Returns
- true if the flag is valid, false otherwise.
|
inline |
Shows the parameterization source for the texture.
- Parameters
-
out_source The parametererization source for the texture.
- Returns
- true if the parameterization source is valid, false otherwise.
|
inline |
Shows the parameter offset for the texture.
- Parameters
-
out_offset The parameter offset for the texture.
- Returns
- true if the offset is valid, false otherwise.
|
inline |
Shows how the texture will be tiled for parameters outside the range [0, 1].
- Parameters
-
out_tiling How the texture will be tiled for parameters outside the range [0, 1].
- Returns
- true if the tiling is valid, false otherwise.
|
inline |
Shows the transform matrix for the texture.
- Parameters
-
out_transform The transform matrix for the texture.
- Returns
- true if the transform matrix is valid, false otherwise.
|
inline |
Shows the value scale for the texture.
- Parameters
-
out_min The value to which zero will be remapped. out_max The value to which one will be remapped.
- Returns
- true if the filter is valid, false otherwise.
|
inline |
Removes whether the texture should act as a decal.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes the decimation filter for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes whether to down-sample the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes all settings from this TextureOptionsKit.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes the interpolation filter for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes whether the texture should modulate with materials from layers below it.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes the parameter source for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes the parameter offset for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes how the texture will be tiled for parameters outside the range [0, 1].
- Returns
- A reference to this TextureOptionsKit.
|
inline |
Removes the transform matrix for the texture.
- Returns
- A reference to this TextureOptionsKit.
|
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