#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The ShaderKit class is a user space object. It is used for specifying all settings related to a ShaderDefinition.
HPS::ShaderKit::ShaderKit |
( |
| ) |
|
The default constructor creates an empty ShaderKit object.
HPS::ShaderKit::ShaderKit |
( |
ShaderKit const & |
in_kit | ) |
|
The copy constructor creates a new ShaderKit object that contains the same settings as the source ShaderKit.
- Parameters
-
HPS::ShaderKit::ShaderKit |
( |
ShaderKit && |
in_that | ) |
|
The move constructor creates a ShaderKit by transferring the underlying impl of the rvalue reference to this ShaderKit thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a ShaderKit to take the impl from. |
bool HPS::ShaderKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this ShaderKit has any values set on it.
- Returns
- true if no values are set on this ShaderKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::ShaderKit::Equals |
( |
ShaderKit const & |
in_kit | ) |
const |
Check if the source ShaderKit is equivalent to this ShaderKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
HPS::Type HPS::ShaderKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::ShaderKit::operator!= |
( |
ShaderKit const & |
in_kit | ) |
const |
Check if the source ShaderKit is not equivalent to this ShaderKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this ShaderKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a ShaderKit to take the impl from. |
- Returns
- A reference to this ShaderKit.
bool HPS::ShaderKit::operator== |
( |
ShaderKit const & |
in_kit | ) |
const |
Check if the source ShaderKit is equivalent to this ShaderKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::ShaderKit::Set |
( |
ShaderKit const & |
in_kit | ) |
|
ShaderKit& HPS::ShaderKit::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 ShaderKit.
Sets the parameterization source for the shader.
- Parameters
-
in_source | The parameterization source for the shader. |
- Returns
- A reference to this ShaderKit.
ShaderKit& HPS::ShaderKit::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 ShaderKit.
Sets the transform matrix for the shader.
- Parameters
-
in_transform | The transform matrix for the shader. |
- Returns
- A reference to this ShaderKit.
void HPS::ShaderKit::Show |
( |
ShaderKit & |
out_kit | ) |
const |
bool HPS::ShaderKit::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.
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.
bool HPS::ShaderKit::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.
bool HPS::ShaderKit::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.
ShaderKit& HPS::ShaderKit::UnsetEverything |
( |
| ) |
|
ShaderKit& HPS::ShaderKit::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 ShaderKit.
ShaderKit& HPS::ShaderKit::UnsetParameterizationSource |
( |
| ) |
|
Removes the parameterization source for the shader.
- Returns
- A reference to this ShaderKit.
Removes the source code for the shader.
- Returns
- A reference to this ShaderKit.
ShaderKit& HPS::ShaderKit::UnsetTransformMatrix |
( |
| ) |
|
Removes the transform matrix for the shader.
- Returns
- A reference to this ShaderKit.
The documentation for this class was generated from the following file:
- C:/git/visualize/hps/include/hps.h