TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual
Represents a parameter of a shader effect.
interface
|
IShaderParameter
|
base of
|
ShaderParameter
|
||
See also:
IShaderEffectReturns the number of array elements.
property
|
Count
{
get
}
|
||
type
|
int32
|
||
value
|
|
The number of elements. | |
The name of this shader parameter.
property
|
Name
{
get
}
|
||
type
|
string
|
||
value
|
|
The parameter name. | |
The type of this shader parameter.
property
|
Type
{
get
}
|
||
type
|
ShaderParameterType
|
||
value
|
The parameter type. | ||
Sets the value of this shader effect parameter.
method
|
SetMatrix2
(Mat2F value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Matrix2Sets the value of this shader effect parameter.
method
|
SetMatrix3
(Mat3F value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Matrix3Sets the value of this shader effect parameter.
method
|
SetMatrix4
(Mat4F value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Matrix4Sets the value of this shader effect parameter.
method
|
SetScalar
(float32 value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.FloatSets the texture of this shader effect parameter.
method
|
SetTexture
(ITexture2D texture,
int32 index = 0)
|
||
params
|
texture
|
The parameter texture. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.TextureSets the texture of this shader effect parameter.
method
|
SetTexture
(ITextureCube texture,
int32 index = 0)
|
||
params
|
texture
|
The parameter texture. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.TextureCubeSets
the
texture
of
this
shader
effect
parameter
to
null.
method
|
SetTextureNull
(int32 index = 0)
|
||
params
|
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
See also:
ShaderParameterType.TextureSets the value of this shader effect parameter.
method
|
SetVector2
(Vec2F value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Vector2Sets the value of this shader effect parameter.
method
|
SetVector3
(Vec3F value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetVector4
(Vec4F value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
[0..Count-1]
|
Array
element
index.
Defaults
to
0. |
|
See also:
ShaderParameterType.Vector4Returns a human-readable expression that describes the type of this shader parameter.
method
|
GetTypeName
()
|
||
type
|
string
|
||
returns
|
|
The parameter type description. | |
Sets the value of this shader effect parameter.
method
|
SetColor
(int32 argb32,
int32 index = 0)
|
||
params
|
argb32
|
The parameter value (32-bit A8R8G8B8 compressed sRGB). | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetColor
(int64 argb64,
int32 index = 0)
|
||
params
|
argb64
|
The parameter value (64-bit A16R16G16B16 linear sRGB). | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetColor
(ColorF color,
int32 index = 0)
|
||
params
|
color
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetMatrix2
(Mat2D value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Matrix2Sets the value of this shader effect parameter.
method
|
SetMatrix3
(Mat3D value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Matrix3Sets the value of this shader effect parameter.
method
|
SetMatrix4
(Mat4D value,
bool transpose = false,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
transpose
|
Use
transpose
of
value?
Defaults
to
false.
|
||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Matrix4Sets the value of this shader effect parameter.
method
|
SetRange
(RangeF value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
Remarks:
Start
is
mapped
to
x,
End
is
mapped
to
y.
See also:
ShaderParameterType.Matrix4Sets the value of this shader effect parameter.
method
|
SetRange
(RangeD value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
Remarks:
Start
is
mapped
to
x,
End
is
mapped
to
y.
See also:
ShaderParameterType.Matrix4Sets the texture of this shader effect parameter.
method
|
SetTexture
(ITexture texture,
int32 index = 0)
|
||
params
|
texture
|
The parameter texture. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.TextureSets the value of this shader effect parameter.
method
|
SetVector2
(Vec2D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector2Sets the value of this shader effect parameter.
method
|
SetVector2
(float32 x,
float32 y,
int32 index = 0)
|
||
params
|
x
|
X-component of parameter value. | |
y
|
Y-component of parameter value. | ||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector2Sets the value of this shader effect parameter.
method
|
SetVector2Extra
(Vec2D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetVector3
(Vec3D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetVector3
(float32 x,
float32 y,
float32 z,
int32 index = 0)
|
||
params
|
x
|
X-component of parameter value. | |
y
|
Y-component of parameter value. | ||
z
|
Z-component of parameter value. | ||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetVector3Extra
(Vec3D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3Sets the value of this shader effect parameter.
method
|
SetVector4
(Vec4D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector4Sets the value of this shader effect parameter.
method
|
SetVector4
(float32 x,
float32 y,
float32 z,
float32 w,
int32 index = 0)
|
||
params
|
x
|
X-component of parameter value. | |
y
|
Y-component of parameter value. | ||
z
|
Z-component of parameter value. | ||
w
|
W-component of parameter value. | ||
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector4Sets the value of this shader effect parameter.
method
|
SetVector4Extra
(Vec4D value,
int32 index = 0)
|
||
params
|
value
|
The parameter value. | |
index
|
Array
element
index.
Defaults
to
0. |
||
See also:
ShaderParameterType.Vector3
info@tinman3d.com
| Copyright © 2012 - 2017 Matthias Englert, Fulda (Germany)