Class ParameterInfo

Parameter information class.

Inheritance

object

ParameterInfo

Namespace: Evergine.Framework.Graphics.Effects.Analyzer

Assembly: Evergine.Framework.dll

Syntax

public class ParameterInfo

Constructors

ParameterInfo(string, string, int, string)

Initializes a new instance of the ParameterInfo class.

Declaration

public ParameterInfo(string name, string type, int offset, string tag)

Parameters

Type	Name	Description
string	name	Parameter name.
string	type	Parameter type (bool, int, float, float2, float3, etc.)
int	offset	Parameter slot (c0, c1.x, c2.w, etc.)
string	tag	Parameter tag ([Default(...)], [Time], [WorldViewProjection], etc.).

ParameterInfo(string, string, string, string, string, List<StructInfo>)

Initializes a new instance of the ParameterInfo class.

Declaration

public ParameterInfo(string name, string type, string offset, string tag, string arrayCount, List<StructInfo> structs)

Parameters

Type	Name	Description
string	name	Parameter name.
string	type	Parameter type (bool, int, float, float2, float3, etc.)
string	offset	Parameter slot (c0, c1.x, c2.w, etc.)
string	tag	Parameter tag ([Default(...)], [Time], [WorldViewProjection], etc.)
string	arrayCount	Array count.
List<StructInfo>	structs	Structs.

Fields

ArrayCount

Parameter array count attribute.

Declaration

public int ArrayCount

Field Value

Type	Description
int

DefaultValue

Default value attribute for a parameter.

Declaration

public object DefaultValue

Field Value

Type	Description
object

Name

Parameter name's attribute.

Declaration

public string Name

Field Value

Type	Description
string

Offset

Parameter offset attribute.

Declaration

public int Offset

Field Value

Type	Description
int

Semantic

Parameter semantic attribute.

Declaration

public ParameterInfo.ParameterSemantic Semantic

Field Value

Type	Description
ParameterInfo.ParameterSemantic

Tag

Parameter tag attribute.

Declaration

public string Tag

Field Value

Type	Description
string

Type

Parameter type attribute.

Declaration

public Type Type

Field Value

Type	Description
Type

TypeSize

Parameter type size attribute.

Declaration

public int TypeSize

Field Value

Type	Description
int

sType

Parameter type in a string attribute.

Declaration

public string sType

Field Value

Type	Description
string

Methods

Equals(ParameterInfo)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(ParameterInfo other)

Parameters

Type	Name	Description
ParameterInfo	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GenerateType(string, List<StructInfo>)

Generates a parameter type from a string type.

Declaration

protected void GenerateType(string stype, List<StructInfo> structs)

Parameters

Type	Name	Description
string	stype	String type.
List<StructInfo>	structs	Struct info collection.

GenerateTypeFromFullName(string)

Generates a parameter type from a string type.

Declaration

protected void GenerateTypeFromFullName(string fullname)

Parameters

Type	Name	Description
string	fullname	The full name of the type.

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

Read(BinaryReader)

Reads a ParameterInfo from a binary file.

Declaration

public static ParameterInfo Read(BinaryReader reader)

Parameters

Type	Name	Description
BinaryReader	reader	The binary reader.

Returns

Type	Description
ParameterInfo	The read ParameterInfo.

ReadDefaultValues(string)

Reads the default value.

Declaration

protected void ReadDefaultValues(string svalue)

Parameters

Type	Name	Description
string	svalue	Value in string format.

ReadOffset(string)

Gets the reading offset.

Declaration

protected int ReadOffset(string offset)

Parameters

Type	Name	Description
string	offset	The offset.

Returns

Type	Description
int	The reading offset.

ReadTag(string)

Reads the tag.

Declaration

protected void ReadTag(string tag)

Parameters

Type	Name	Description
string	tag	The tag.

Write(BinaryWriter)

Writes a ParameterInfo into a binary file.

Declaration

public void Write(BinaryWriter writer)

Parameters

Type	Name	Description
BinaryWriter	writer	The binary writer.

Operators

operator ==(ParameterInfo, ParameterInfo)

Declaration

public static bool operator ==(ParameterInfo value1, ParameterInfo value2)

Parameters

Type	Name	Description
ParameterInfo	value1
ParameterInfo	value2

Returns

Type	Description
bool

operator !=(ParameterInfo, ParameterInfo)

Declaration

public static bool operator !=(ParameterInfo value1, ParameterInfo value2)

Parameters

Type	Name	Description
ParameterInfo	value1
ParameterInfo	value2

Returns

Type	Description
bool

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)