EffectParameter

java.lang.Object
- Microsoft.Xna.Framework.Graphics.EffectParameter

public final class EffectParameter
extends java.lang.Object

Represents an Effect parameter.

Author:: Halofreak1990

Method Summary

Methods
Modifier and Type	Method and Description
`EffectAnnotationCollection`	`getAnnotations()` Gets the collection of EffectAnnotation objects for this parameter.
`int`	`getColumnCount()` Gets the number of columns in the parameter description.
`EffectParameterCollection`	`getElements()` Gets the collection of effect parameters.
`java.lang.String`	`getName()` Gets the name of the parameter.
`EffectParameterClass`	`getParameterClass()` Gets the class of the parameter.
`EffectParameterType`	`getParameterType()` Gets the type of the parameter.
`int`	`getRowCount()` Gets the number of rows in the parameter description.
`java.lang.String`	`getSemantic()` Gets the semantic meaning, or usage, of the parameter.
`EffectParameterCollection`	`getStructureMembers()` Gets the collection of structure members.
`boolean`	`GetValueBoolean()` Gets the value of the EffectParameter as a Boolean.
`boolean[]`	`GetValueBooleanArray(int count)` Gets the value of the EffectParameter as an array of Boolean.
`int`	`GetValueInt32()` Gets the value of the EffectParameter as an Int32.
`int[]`	`GetValueInt32Array(int count)` Gets the value of the EffectParameter as an array of Int32.
`Matrix`	`GetValueMatrix()` Gets the value of the EffectParameter as a Matrix.
`Matrix[]`	`GetValueMatrixArray(int count)` Gets the value of the EffectParameter as an array of Matrix.
`Matrix`	`GetValueMatrixTranspose()` Gets the value of the EffectParameter as a transposed Matrix.
`Matrix[]`	`GetValueMatrixTransposeArray(int count)` Gets the value of the EffectParameter as an array of transposed Matrices.
`Quaternion`	`GetValueQuaternion()` Gets the value of the EffectParameter as a Quaternion.
`Quaternion[]`	`GetValueQuaternionArray(int count)` Gets the value of the EffectParameter as an array of Quaternion.
`float`	`GetValueSingle()` Gets the value of the EffectParameter as a Single.
`float[]`	`GetValueSingleArray(int count)` Gets the value of the EffectParameter as an array of Single.
`java.lang.String`	`GetValueString()` Gets the value of the EffectParameter as an String.
`Texture2D`	`GetValueTexture2D()` Gets the value of the EffectParameter as a Texture2D.
`Texture3D`	`GetValueTexture3D()` Gets the value of the EffectParameter as a Texture3D.
`TextureCube`	`GetValueTextureCube()` Gets the value of the EffectParameter as a TextureCube.
`Vector2`	`GetValueVector2()` Gets the value of the EffectParameter as a Vector3.
`Vector3`	`GetValueVector3()` Gets the value of the EffectParameter as a Vector3.
`void`	`SetValue(boolean value)` Sets the value of the EffectParameter.
`void`	`SetValue(boolean[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(float value)` Sets the value of the EffectParameter.
`void`	`SetValue(float[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(int value)` Sets the value of the EffectParameter.
`void`	`SetValue(int[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(Matrix value)` Sets the value of the EffectParameter.
`void`	`SetValue(Matrix[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(Quaternion value)` Sets the value of the EffectParameter.
`void`	`SetValue(Quaternion[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(java.lang.String value)` Sets the value of the EffectParameter.
`void`	`SetValue(Texture value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector2 value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector2[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector3 value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector3[] value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector4 value)` Sets the value of the EffectParameter.
`void`	`SetValue(Vector4[] value)` Sets the value of the EffectParameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAnnotations
```
public EffectAnnotationCollection getAnnotations()
```
    Gets the collection of EffectAnnotation objects for this parameter.
    
    Returns:
    The collection of EffectAnnotation objects for this parameter.
  - getColumnCount
```
public int getColumnCount()
```
    Gets the number of columns in the parameter description.
    
    Returns:
    The number of columns in the parameter description.
  - getElements
```
public EffectParameterCollection getElements()
```
    Gets the collection of effect parameters.
    
    Returns:
    The collection of effect parameters.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the parameter.
    
    Returns:
    The name of the parameter.
  - getParameterClass
```
public EffectParameterClass getParameterClass()
```
    Gets the class of the parameter.
    
    Returns:
    The class of the parameter.
  - getParameterType
```
public EffectParameterType getParameterType()
```
    Gets the type of the parameter.
    
    Returns:
    The type of the parameter.
  - getRowCount
```
public int getRowCount()
```
    Gets the number of rows in the parameter description.
    
    Returns:
    The number of rows in the parameter description.
  - getSemantic
```
public java.lang.String getSemantic()
```
    Gets the semantic meaning, or usage, of the parameter.
    
    Returns:
    The semantic meaning, or usage, of the parameter.
  - getStructureMembers
```
public EffectParameterCollection getStructureMembers()
```
    Gets the collection of structure members.
    
    Returns:
    The collection of structure members.
  - GetValueBoolean
```
public boolean GetValueBoolean()
```
    Gets the value of the EffectParameter as a Boolean.
  - GetValueBooleanArray
```
public boolean[] GetValueBooleanArray(int count)
```
    Gets the value of the EffectParameter as an array of Boolean.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
    The value of the EffectParameter as an array of Boolean.
  - GetValueInt32
```
public int GetValueInt32()
```
    Gets the value of the EffectParameter as an Int32.
  - GetValueInt32Array
```
public int[] GetValueInt32Array(int count)
```
    Gets the value of the EffectParameter as an array of Int32.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
  - GetValueMatrix
```
public Matrix GetValueMatrix()
```
    Gets the value of the EffectParameter as a Matrix.
    
    Returns:
  - GetValueMatrixArray
```
public Matrix[] GetValueMatrixArray(int count)
```
    Gets the value of the EffectParameter as an array of Matrix.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
  - GetValueMatrixTranspose
```
public Matrix GetValueMatrixTranspose()
```
    Gets the value of the EffectParameter as a transposed Matrix.
    
    Returns:
  - GetValueMatrixTransposeArray
```
public Matrix[] GetValueMatrixTransposeArray(int count)
```
    Gets the value of the EffectParameter as an array of transposed Matrices.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
  - GetValueQuaternion
```
public Quaternion GetValueQuaternion()
```
    Gets the value of the EffectParameter as a Quaternion.
    
    Returns:
  - GetValueQuaternionArray
```
public Quaternion[] GetValueQuaternionArray(int count)
```
    Gets the value of the EffectParameter as an array of Quaternion.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
  - GetValueSingle
```
public float GetValueSingle()
```
    Gets the value of the EffectParameter as a Single.
    
    Returns:
  - GetValueSingleArray
```
public float[] GetValueSingleArray(int count)
```
    Gets the value of the EffectParameter as an array of Single.
    
    Parameters:
    count - The number of elements in the array.
    
    Returns:
  - GetValueString
```
public java.lang.String GetValueString()
```
    Gets the value of the EffectParameter as an String.
    
    Returns:
  - GetValueTexture2D
```
public Texture2D GetValueTexture2D()
```
    Gets the value of the EffectParameter as a Texture2D.
    
    Returns:
  - GetValueTexture3D
```
public Texture3D GetValueTexture3D()
```
    Gets the value of the EffectParameter as a Texture3D.
    
    Returns:
  - GetValueTextureCube
```
public TextureCube GetValueTextureCube()
```
    Gets the value of the EffectParameter as a TextureCube.
    
    Returns:
  - GetValueVector2
```
public Vector2 GetValueVector2()
```
    Gets the value of the EffectParameter as a Vector3.
    
    Returns:
  - GetValueVector3
```
public Vector3 GetValueVector3()
```
    Gets the value of the EffectParameter as a Vector3.
    
    Returns:
  - SetValue
```
public void SetValue(Matrix[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Quaternion[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Texture value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Matrix value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Quaternion value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector2 value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector3 value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector4 value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(boolean value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(int value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(float value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector2[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector3[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(Vector4[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(java.lang.String value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(boolean[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(int[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.
  - SetValue
```
public void SetValue(float[] value)
```
    Sets the value of the EffectParameter.
    
    Parameters:
    value - The value to assign to the EffectParameter.

Class EffectParameter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAnnotations

getColumnCount

getElements

getName

getParameterClass

getParameterType

getRowCount

getSemantic

getStructureMembers

GetValueBoolean

GetValueBooleanArray

GetValueInt32

GetValueInt32Array

GetValueMatrix

GetValueMatrixArray

GetValueMatrixTranspose

GetValueMatrixTransposeArray

GetValueQuaternion

GetValueQuaternionArray

GetValueSingle

GetValueSingleArray

GetValueString

GetValueTexture2D

GetValueTexture3D

GetValueTextureCube

GetValueVector2

GetValueVector3

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue

SetValue