#include <hps.h>

Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::LegacyShaderKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
Internal use only - customers should not use. The LegacyShaderKit class is a user space object. It is used for specifying all settings related to a LegacyShaderDefinition.
Constructor & Destructor Documentation
◆ LegacyShaderKit() [1/3]
HPS::LegacyShaderKit::LegacyShaderKit | ( | ) |
The default constructor creates an empty LegacyShaderKit object.
◆ LegacyShaderKit() [2/3]
HPS::LegacyShaderKit::LegacyShaderKit | ( | LegacyShaderKit const & | in_kit | ) |
The copy constructor creates a new LegacyShaderKit object that contains the same settings as the source LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to copy.
◆ LegacyShaderKit() [3/3]
HPS::LegacyShaderKit::LegacyShaderKit | ( | LegacyShaderKit && | in_that | ) |
The move constructor creates a LegacyShaderKit by transferring the underlying impl of the rvalue reference to this LegacyShaderKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a LegacyShaderKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this LegacyShaderKit has any values set on it.
- Returns
- true if no values are set on this LegacyShaderKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::LegacyShaderKit::Equals | ( | LegacyShaderKit const & | in_kit | ) | const |
Check if the source LegacyShaderKit is equivalent to this LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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::LegacyShaderKit::operator!= | ( | LegacyShaderKit const & | in_kit | ) | const |
Check if the source LegacyShaderKit is not equivalent to this LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
LegacyShaderKit& HPS::LegacyShaderKit::operator= | ( | LegacyShaderKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this LegacyShaderKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a LegacyShaderKit to take the impl from.
- Returns
- A reference to this LegacyShaderKit.
◆ operator=() [2/2]
LegacyShaderKit& HPS::LegacyShaderKit::operator= | ( | LegacyShaderKit const & | in_kit | ) |
Copies the source LegacyShaderKit into this LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to copy.
- Returns
- A reference to this LegacyShaderKit.
◆ operator==()
bool HPS::LegacyShaderKit::operator== | ( | LegacyShaderKit const & | in_kit | ) | const |
Check if the source LegacyShaderKit is equivalent to this LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to compare to this LegacyShaderKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::LegacyShaderKit::Set | ( | LegacyShaderKit const & | in_kit | ) |
Copies the source LegacyShaderKit into this LegacyShaderKit.
- Parameters
-
in_kit The source LegacyShaderKit to copy.
◆ SetMultitexture()
LegacyShaderKit& HPS::LegacyShaderKit::SetMultitexture | ( | bool | in_state | ) |
Sets whether to apply diffuse textures from layers greater than <span class='code>0 on top of the shader when it is applied to geometry.
- Parameters
-
in_state Whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry. If true, the additional textures will be applied; if false, the addtional textures will not be applied.
- Returns
- A reference to this LegacyShaderKit.
◆ SetParameterizationSource()
LegacyShaderKit& HPS::LegacyShaderKit::SetParameterizationSource | ( | LegacyShader::Parameterization | in_source | ) |
Sets the parameterization source for the shader.
- Parameters
-
in_source The parameterization source for the shader.
- Returns
- A reference to this LegacyShaderKit.
◆ SetSource()
LegacyShaderKit& HPS::LegacyShaderKit::SetSource | ( | char const * | in_source | ) |
Sets the source code for the shader.
- Parameters
-
in_source The source code for the shader.
- Returns
- A reference to this LegacyShaderKit.
◆ SetTransformMatrix()
LegacyShaderKit& HPS::LegacyShaderKit::SetTransformMatrix | ( | MatrixKit const & | in_transform | ) |
Sets the transform matrix for the shader.
- Parameters
-
in_transform The transform matrix for the shader.
- Returns
- A reference to this LegacyShaderKit.
◆ Show()
void HPS::LegacyShaderKit::Show | ( | LegacyShaderKit & | out_kit | ) | const |
Copies this LegacyShaderKit into the given LegacyShaderKit.
- Parameters
-
out_kit The LegacyShaderKit to populate with the contents of this LegacyShaderKit.
◆ ShowMultitexture()
bool HPS::LegacyShaderKit::ShowMultitexture | ( | bool & | out_state | ) | const |
Shows whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
- Parameters
-
out_state whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
- Returns
- true if the flag is valid, false otherwise.
◆ ShowParameterizationSource()
bool HPS::LegacyShaderKit::ShowParameterizationSource | ( | LegacyShader::Parameterization & | out_source | ) | const |
Shows the parameterization source for the shader.
- Parameters
-
out_source The parameterization source for the shader.
- Returns
- true if the parameterization source is valid, false otherwise.
◆ ShowSource()
bool HPS::LegacyShaderKit::ShowSource | ( | UTF8 & | out_source | ) | const |
Shows the source code for the shader.
- Parameters
-
out_source The source code for the shader.
- Returns
- true if the source code is valid, false otherwise.
◆ ShowTransformMatrix()
bool HPS::LegacyShaderKit::ShowTransformMatrix | ( | MatrixKit & | out_transform | ) | const |
Shows the transform matrix for the shader.
- Parameters
-
out_transform The transform matrix for the shader.
- Returns
- true if the transform is valid, false otherwise.
◆ UnsetEverything()
LegacyShaderKit& HPS::LegacyShaderKit::UnsetEverything | ( | ) |
Removes all settings from this LegacyShaderKit.
- Returns
- A reference to this LegacyShaderKit.
◆ UnsetMultitexture()
LegacyShaderKit& HPS::LegacyShaderKit::UnsetMultitexture | ( | ) |
Removes whether to apply diffuse textures from layers greater than 0 on top of the shader when it is applied to geometry.
- Returns
- A reference to this LegacyShaderKit.
◆ UnsetParameterizationSource()
LegacyShaderKit& HPS::LegacyShaderKit::UnsetParameterizationSource | ( | ) |
Removes the parameterization source for the shader.
- Returns
- A reference to this LegacyShaderKit.
◆ UnsetSource()
LegacyShaderKit& HPS::LegacyShaderKit::UnsetSource | ( | ) |
Removes the source code for the shader.
- Returns
- A reference to this LegacyShaderKit.
◆ UnsetTransformMatrix()
LegacyShaderKit& HPS::LegacyShaderKit::UnsetTransformMatrix | ( | ) |
Removes the transform matrix for the shader.
- Returns
- A reference to this LegacyShaderKit.
The documentation for this class was generated from the following file:
- include/hps.h