#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::TextureOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ TextureOptionsKit() [1/3]
HPS::TextureOptionsKit::TextureOptionsKit |
( |
| ) |
|
◆ TextureOptionsKit() [2/3]
◆ TextureOptionsKit() [3/3]
The move constructor creates a TextureOptionsKit by transferring the underlying impl of the rvalue reference to this TextureOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
◆ Empty()
bool HPS::TextureOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
◆ 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.
- Returns
- A TextureOptionsKit with the default settings.
◆ ObjectType()
HPS::Type HPS::TextureOptionsKit::ObjectType |
( |
| ) |
const |
|
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.
◆ operator!=()
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this TextureOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this TextureOptionsKit.
◆ operator=() [2/2]
◆ operator==()
◆ Set()
◆ SetDecal()
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.
◆ SetDecimationFilter()
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.
◆ SetDownSampling()
Sets whether the texture should be down-sampled.
- Parameters
-
in_state | Whether the texture should be down-sampled. |
- Returns
- A reference to this TextureOptionsKit.
◆ SetInterpolationFilter()
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.
◆ SetModulation()
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.
◆ SetParameterizationSource()
Sets the parameterization source for the texture.
- Parameters
-
in_source | The parameterization source for the texture. |
- Returns
- A reference to this TextureOptionsKit.
◆ SetParameterOffset()
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.
◆ SetTiling()
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.
◆ SetTransformMatrix()
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.
◆ SetValueScale()
TextureOptionsKit& HPS::TextureOptionsKit::SetValueScale |
( |
float |
in_min, |
|
|
float |
in_max |
|
) |
| |
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.
◆ Show()
◆ ShowDecal()
bool HPS::TextureOptionsKit::ShowDecal |
( |
bool & |
out_state | ) |
const |
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.
◆ ShowDecimationFilter()
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.
◆ ShowDownSampling()
bool HPS::TextureOptionsKit::ShowDownSampling |
( |
bool & |
out_state | ) |
const |
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.
◆ ShowInterpolationFilter()
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.
◆ ShowModulation()
bool HPS::TextureOptionsKit::ShowModulation |
( |
bool & |
out_state | ) |
const |
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.
◆ ShowParameterizationSource()
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.
◆ ShowParameterOffset()
bool HPS::TextureOptionsKit::ShowParameterOffset |
( |
size_t & |
out_offset | ) |
const |
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.
◆ ShowTiling()
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.
◆ ShowTransformMatrix()
bool HPS::TextureOptionsKit::ShowTransformMatrix |
( |
MatrixKit & |
out_transform | ) |
const |
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.
◆ ShowValueScale()
bool HPS::TextureOptionsKit::ShowValueScale |
( |
float & |
out_min, |
|
|
float & |
out_max |
|
) |
| const |
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.
◆ UnsetDecal()
Removes whether the texture should act as a decal.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetDecimationFilter()
Removes the decimation filter for the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetDownSampling()
Removes whether to down-sample the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetEverything()
◆ UnsetInterpolationFilter()
Removes the interpolation filter for the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetModulation()
Removes whether the texture should modulate with materials from layers below it.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetParameterizationSource()
Removes the parameter source for the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetParameterOffset()
Removes the parameter offset for the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetTiling()
Removes how the texture will be tiled for parameters outside the range [0, 1].
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetTransformMatrix()
Removes the transform matrix for the texture.
- Returns
- A reference to this TextureOptionsKit.
◆ UnsetValueScale()
Removes the value scale for the texture.
- Returns
- A reference to this TextureOptionsKit.
The documentation for this class was generated from the following file: