#include <hps.h>

Static Public Member Functions | |
static TextureOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::TextureOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
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/3]
HPS::TextureOptionsKit::TextureOptionsKit | ( | ) |
The default constructor creates an empty TextureOptionsKit object.
◆ TextureOptionsKit() [2/3]
HPS::TextureOptionsKit::TextureOptionsKit | ( | TextureOptionsKit const & | in_kit | ) |
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.
◆ TextureOptionsKit() [3/3]
HPS::TextureOptionsKit::TextureOptionsKit | ( | TextureOptionsKit && | in_that | ) |
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
-
in_that An rvalue reference to a TextureOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
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 | ( | TextureOptionsKit const & | in_kit | ) | const |
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.
◆ GetDefault()
|
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.
- Returns
- A TextureOptionsKit with the default settings.
◆ 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.
◆ operator!=()
bool HPS::TextureOptionsKit::operator!= | ( | TextureOptionsKit const & | in_kit | ) | const |
Check if the source TextureOptionsKit is not equivalent to this TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to compare to this TextureOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
TextureOptionsKit& HPS::TextureOptionsKit::operator= | ( | TextureOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TextureOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a TextureOptionsKit to take the impl from.
- Returns
- A reference to this TextureOptionsKit.
◆ operator=() [2/2]
TextureOptionsKit& HPS::TextureOptionsKit::operator= | ( | TextureOptionsKit const & | in_kit | ) |
Copies the source TextureOptionsKit into this TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to copy.
- Returns
- A reference to this TextureOptionsKit.
◆ operator==()
bool HPS::TextureOptionsKit::operator== | ( | TextureOptionsKit const & | in_kit | ) | const |
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.
◆ Set()
void HPS::TextureOptionsKit::Set | ( | TextureOptionsKit const & | in_kit | ) |
Copies the source TextureOptionsKit into this TextureOptionsKit.
- Parameters
-
in_kit The source TextureOptionsKit to copy.
◆ SetDecal()
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.
- Parameters
-
in_state Whether the texture should act as a decal.
- Returns
- A reference to this TextureOptionsKit.