Detailed Description
Represents a shader parameter as a specialization of the Parameter interface on a Shader.
This interface also has its own specialization for shader array parameters: ShaderArrayParameter.
- Since:
- 9.0 (2011)
#include <xsi_shaderparameter.h>
Public Member Functions |
|
| ShaderParameter () | |
| ~ShaderParameter () | |
| ShaderParameter (const CRef &in_ref) | |
| ShaderParameter (const ShaderParameter &in_obj) | |
| bool | IsA (siClassID in_ClassID) const |
| siClassID | GetClassID () const |
| ShaderParameter & | operator= (const ShaderParameter &in_obj) |
| ShaderParameter & | operator= (const CRef &in_ref) |
| ShaderParamDef | GetDefinition () const |
| siShaderParameterDataType | GetDataType () const |
| CRefArray | GetTargets () const |
Constructor & Destructor Documentation
| ShaderParameter | ( | ) |
Default constructor.
| ~ShaderParameter | ( | ) |
Default destructor.
| ShaderParameter | ( | const CRef & | in_ref | ) |
Constructor.
- Parameters:
-
in_ref constant reference object.
| ShaderParameter | ( | const ShaderParameter & | in_obj | ) |
Copy constructor.
- Parameters:
-
in_obj constant class object.
Member Function Documentation
| bool IsA | ( | siClassID | in_ClassID | ) | const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
in_ClassID class type.
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from Parameter.
Reimplemented in ShaderArrayParameter.
| siClassID GetClassID | ( | ) | const [virtual] |
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from Parameter.
Reimplemented in ShaderArrayParameter.
| ShaderParameter& operator= | ( | const ShaderParameter & | in_obj | ) |
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj constant class object.
- Returns:
- The new ShaderParameter object.
| ShaderParameter& operator= | ( | const CRef & | in_ref | ) |
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref constant class object.
- Returns:
- The new ShaderParameter object.
Reimplemented from Parameter.
Reimplemented in ShaderArrayParameter.
| ShaderParamDef GetDefinition | ( | ) | const |
Returns the shader parameter definition as a ShaderParamDef object.
- Returns:
- the ShaderParamDef object
- Since:
- 9.0 (2011)
| siShaderParameterDataType GetDataType | ( | ) | const |
Returns one of the siShaderParameterDataType enum values corresponding to this shader parameter's data type.
- Returns:
- Data type for this shader parameter
- See also:
- ShaderParamDef::GetDataType
- Since:
- 9.0 (2011)
| CRefArray GetTargets | ( | ) | const |
Returns the shader parameter targets connected to this parameter.
- Returns:
- Array of references to the targets
- Since:
- 9.0 (2011)
The documentation for this class was generated from the following file:
