class ShaderParameterBuffer
ShaderParameterBuffer defines a custom buffer which is used by the evaluation shader. The buffer data is served to the shader as is, and is not interpolated.
Properties
| Property | Description |
|---|
| FieldName | The name of the custom field in the scene or caster source object which is mapped to the shader. |
| Name | The name of the ShaderParameterBuffer object. (Inherited from Object) |
| Type | The user-specified type which is used to map the buffer. The type is shader language-specific and must have been declared in the ShaderHeader of the shader object, or be one of the build in types of the shader language. |
Methods
| Method | Description |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the ShaderParameterBuffer class. (Inherited from Object) |
| IsA | Returns true if ShaderParameterBuffer is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ShaderParameterBuffer object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ShaderParameterBuffer object is valid. (Inherited from Object) |
| NonNull | Returns true if the ShaderParameterBuffer object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ShaderParameterBuffer object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spShaderParameterBuffer, and if this is the case, returns the object cast into spShaderParameterBuffer. (Inherited from Object) |
Properties details
FieldName
The name of the custom field in the scene or caster source object which is mapped to the shader.
Syntax
SetFieldName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired texture to bind to. |
GetFieldName return value
Type: spString
Syntax
SetFieldName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired texture to bind to. |
GetFieldName return value
Type: string
Syntax
SetFieldName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired texture to bind to. |
GetFieldName return value
Type: str
Name
The name of the ShaderParameterBuffer object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
Type
The user-specified type which is used to map the buffer. The type is shader language-specific and must have been declared in the ShaderHeader of the shader object, or be one of the build in types of the shader language.
Syntax
SetType parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired type |
GetType return value
Type: spString
Syntax
SetType parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired type |
GetType return value
Type: string
Syntax
SetType parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | The desired type |
GetType return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetClass
Get the name of the ShaderParameterBuffer class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
IsA
Returns true if ShaderParameterBuffer is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ShaderParameterBuffer is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if ShaderParameterBuffer is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if ShaderParameterBuffer is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ShaderParameterBuffer object is invalid. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ShaderParameterBuffer object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the ShaderParameterBuffer object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ShaderParameterBuffer object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
string | type | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| type | str | | | Name of the class to check if the class is, or is a descendant of. |
Return value
Type: bool
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spShaderParameterBuffer, and if this is the case, returns the object cast into spShaderParameterBuffer. (Inherited from Object)
