Detailed Description
Represents a definition for a shader parameter (an instance a ShaderArrayParameter object).
This class allows you to set and get the array elements contained by this shader parameter via ShaderArrayParamDef::GetItemInitialValues, which returns a ValueMap object that you can populate or query.
To create a ShaderArrayParamDef object, use the ShaderParamDefContainer::AddArrayParamDef method when adding a new parameter definition to the shader parameter definition container.
- See also:
- ShaderParamDefContainer::AddParamDef, ShaderParamDefContainer::AddArrayParamDef, ShaderParameter::GetDefinition, ShaderParamDefContainer, ShaderStructParamDef, ShaderDefinitions/netview_ShaderDefs Color Sampler example
- Since:
- 9.0 (2011)
#include <xsi_shaderarrayparamdef.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
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:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from ShaderParamDef.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from ShaderParamDef.
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 ShaderArrayParamDef object.
- Since:
- 9.0 (2011)
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 ShaderArrayParamDef object.
- Since:
- 9.0 (2011)
Reimplemented from ShaderParamDef.
Returns the underlying ShaderParamDef or ShaderStructParamDef object for this array item.
You can use this when you want to query an existing shader definition to find out information about its parameter definitions. For example, if you are writing a tool to find a parameter defined as an array of booleans.
- Returns:
- the parameter definition for the array item.
- See also:
- ShaderArrayParameter
- Since:
- 9.0 (2011)
ULONG GetItemInitialCount |
( |
| ) |
const |
CStatus PutItemInitialCount |
( |
ULONG |
in_count | ) |
|
Returns the array item's base name. When more than one array item based on this definition is instantiated, the base name is suffixed with an index ID. For example, if this property is set to "West"
, the first instance will be "West"
, the second will be "West[1]"
, the third "West[2]"
and so on.
- Note:
- This function has no effect on the display name (see ShaderParamDef::GetDisplayName).
- Returns:
- the array item's name.
- See also:
- ShaderArrayParamDef::GetItemInitialCount, ShaderArrayParamDef::PutItemInitialCount, ShaderArrayParamDef::GetItemInitialValues, ShaderArrayParameter, SIObject::GetName, Parameter::GetScriptName
- Since:
- 9.0 (2011)
Sets the array item's base name. When more than one array item based on this definition is instantiated, the base name is suffixed with an index ID. For example, if this property is set to "West"
, the first instance will be "West"
, the second will be "West[1]"
, the third "West[2]"
and so on.
- Parameters:
-
in_name | the Array Item's Name. |
- Returns:
- Success/failure
- See also:
- ShaderArrayParamDef::GetItemInitialCount, ShaderArrayParamDef::PutItemInitialCount, ShaderArrayParamDef::GetItemInitialValues, ShaderArrayParameter, SIObject::GetName, Parameter::GetScriptName
- Since:
- 9.0 (2011)
bool GetStaticArray |
( |
| ) |
const |
Returns whether the array can be resized or not.
- Returns:
- false if the array can be resized
-
true otherwise
- See also:
- ShaderArrayParameter
- Since:
- 9.0 (2011)
CStatus PutStaticArray |
( |
bool |
in_static | ) |
|
Sets whether the array can be resized or not.
- Parameters:
-
in_static | true for static array; false for dynamic. |
- Returns:
- Success/failure
- See also:
- ShaderArrayParameter
- Since:
- 9.0 (2011)
The documentation for this class was generated from the following file: