REFERENCE MANUAL
The TextureOptionsKit class is a user space object. More...
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 () |
This function returns the type the object, as declared. More... | |
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. 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. 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... | |
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... | |
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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.TextureOptionsKit | GetDefault () |
Creates a TextureOptionsKit which contains the default settings. 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 |
HandleRef | scptr |
The TextureOptionsKit class is a user space object.
It is used for setting texture options when defining textures or cube maps. Calling TextureOptionsKit::GetDefault() will return an options kit with values found in this table.
HPS.TextureOptionsKit.TextureOptionsKit | ( | ) |
The default constructor creates an empty TextureOptionsKit object.
HPS.TextureOptionsKit.TextureOptionsKit | ( | HPS.TextureOptionsKit | in_kit | ) |
The copy constructor creates a new TextureOptionsKit object that contains the same settings as the source TextureOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this TextureOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.TextureOptionsKit.Equals | ( | HPS.TextureOptionsKit | in_kit | ) |
Check if the source TextureOptionsKit is equivalent to this TextureOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref>. |
|
static |
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.TextureOptionsKit.Set | ( | HPS.TextureOptionsKit | in_kit | ) |
Copies the source TextureOptionsKit into this TextureOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref> to copy. |
HPS.TextureOptionsKit 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.
in_state | Whether the texture should act as a decal. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetDecimationFilter | ( | HPS.Material.Texture.Decimation | in_filter | ) |
Sets the decimation filter to use for the texture.
in_filter | The decimation filter to use for the texture. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetDownSampling | ( | bool | in_state | ) |
Sets whether the texture should be down-sampled.
in_state | Whether the texture should be down-sampled. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetInterpolationFilter | ( | HPS.Material.Texture.Interpolation | in_filter | ) |
Sets the interpolation filter to use for the texture.
in_filter | The interpolation filter to use for the texture. |
HPS.TextureOptionsKit 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.
in_state | Whether the texture should be modulated with materials from layers below it. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetParameterizationSource | ( | HPS.Material.Texture.Parameterization | in_source | ) |
Sets the parameterization source for the texture.
in_source | The parameterization source for the texture. |
HPS.TextureOptionsKit 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.
in_offset | The parameter offset for the texture. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetTiling | ( | HPS.Material.Texture.Tiling | in_tiling | ) |
Sets how the texture will be tiled for parameters outside the range [0, 1].
in_tiling | How the texture will be tiled for parameters outside the range [0, 1]. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.SetTransformMatrix | ( | HPS.MatrixKit | in_transform | ) |
Sets the transform matrix to use for the texture.
in_transform | The transform matrix to use for the texture. |
void HPS.TextureOptionsKit.Show | ( | out HPS.TextureOptionsKit | out_kit | ) |
Copies this TextureOptionsKit into the given TextureOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_texture_options_kit" kindref="compound">TextureOptionsKit</ref>. |
bool HPS.TextureOptionsKit.ShowDecal | ( | out bool | out_state | ) |
Shows whether the texture should act as a decal.
out_state | Whether the texture should act as a decal. |
bool HPS.TextureOptionsKit.ShowDecimationFilter | ( | out HPS.Material.Texture.Decimation | out_filter | ) |
Shows the decimation filter for the texture.
out_filter | The decimation filter for the texture. |
bool HPS.TextureOptionsKit.ShowDownSampling | ( | out bool | out_state | ) |
Shows whether the texture should be down-sampled.
out_state | Whether the texture should be down-sampled. |
bool HPS.TextureOptionsKit.ShowInterpolationFilter | ( | out HPS.Material.Texture.Interpolation | out_filter | ) |
Shows the interpolation filter for the texture.
out_filter | The interpolation filter for the texture. |
bool HPS.TextureOptionsKit.ShowModulation | ( | out bool | out_state | ) |
Shows whether the texture should be modulated with materials from layers below it.
out_state | Whether the texture should be be modulated with materials from layers below it. |
bool HPS.TextureOptionsKit.ShowParameterizationSource | ( | out HPS.Material.Texture.Parameterization | out_source | ) |
Shows the parameterization source for the texture.
out_source | The parametererization source for the texture. |
bool HPS.TextureOptionsKit.ShowParameterOffset | ( | out ulong | out_offset | ) |
Shows the parameter offset for the texture.
out_offset | The parameter offset for the texture. |
bool HPS.TextureOptionsKit.ShowTiling | ( | out HPS.Material.Texture.Tiling | out_tiling | ) |
Shows how the texture will be tiled for parameters outside the range [0, 1].
out_tiling | How the texture will be tiled for parameters outside the range [0, 1]. |
bool HPS.TextureOptionsKit.ShowTransformMatrix | ( | out HPS.MatrixKit | out_transform | ) |
Shows the transform matrix for the texture.
out_transform | The transform matrix for the texture. |
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDecal | ( | ) |
Removes whether the texture should act as a decal.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDecimationFilter | ( | ) |
Removes the decimation filter for the texture.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetDownSampling | ( | ) |
Removes whether to down-sample the texture.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this TextureOptionsKit.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetInterpolationFilter | ( | ) |
Removes the interpolation filter for the texture.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetModulation | ( | ) |
Removes whether the texture should modulate with materials from layers below it.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetParameterizationSource | ( | ) |
Removes the parameter source for the texture.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetParameterOffset | ( | ) |
Removes the parameter offset for the texture.
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetTiling | ( | ) |
Removes how the texture will be tiled for parameters outside the range [0, 1].
HPS.TextureOptionsKit HPS.TextureOptionsKit.UnsetTransformMatrix | ( | ) |
Removes the transform matrix for the texture.