Table of Contents

Graphics

(NOTE) Vertex data and attribute semantics for defining data that can be uploaded to the gpu.

Methods Properties Base Classes Derived Classes
AddAttribute VertexCount safeid32
AddByte
AddReal
AddShort
ClearAttributes
ClearData
GetAttributes
GetElementCount
GetElementType
GetVertexData
IsValidVertexData

Properties


VertexCount : integer

read-only

Returns the number of vertices that have a complete set of data stored.

var VertexCount : Integer

Methods


AddAttribute : Void

Adds an attribute to the definition of the vertices that are to be stored. Add the attributes in the order that they should be stored in memory on a vertex. |Name|Type|Description| |---|---|---| |semantic|VertexSemantic| | |elementType|VertexElementType| | |elementCount|integer| |

function AddAttribute(semantic : VertexSemantic, elementType : VertexElementType, elementCount : Integer)

AddByte : Void

Adds data as bytes to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|integer| |

function AddByte(value : Integer)

AddByte : Void

Adds data as bytes to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer2| |

function AddByte( : Integer2)

AddByte : Void

Adds data as bytes to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer3| |

function AddByte( : Integer3)

AddByte : Void

Adds data as bytes to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer4| |

function AddByte( : Integer4)

AddReal : Void

Adds data as floats to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|real| |

function AddReal(value : Real)

AddReal : Void

Adds data as floats to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|real2| |

function AddReal(value : Real2)

AddReal : Void

Adds data as floats to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|real3| |

function AddReal(value : Real3)

AddReal : Void

Adds data as floats to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|real4| |

function AddReal(value : Real4)

AddShort : Void

Adds data as shorts to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| |value|integer| |

function AddShort(value : Integer)

AddShort : Void

Adds data as shorts to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer2| |

function AddShort( : Integer2)

AddShort : Void

Adds data as shorts to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer3| |

function AddShort( : Integer3)

AddShort : Void

Adds data as shorts to the buffer, data is expected in the order of the attributes, one vertex after another. |Name|Type|Description| |---|---|---| ||integer4| |

function AddShort( : Integer4)

ClearAttributes : Void

Clears all added attributes from the vertex definition so they can be redefined. |Name|Type|Description| |---|---|---|

function ClearAttributes()

ClearData : Void

Clears all added vertex data so new data can be added. |Name|Type|Description| |---|---|---|

function ClearData()

GetAttributes : vertexsemanticrange

Returns a range of attribute semantics in the order that they were added. |Name|Type|Description| |---|---|---|

function GetAttributes() : VertexSemanticRange

GetElementCount : integer

Returns the number of elements stored for the given attribute, throws exception if the attribute is not in the vertex definition. |Name|Type|Description| |---|---|---| |semantic|VertexSemantic| |

function GetElementCount(semantic : VertexSemantic) : Integer

GetElementType : VertexElementType

Returns the type that is used to store the given attribute, throws exception if the attribute is not in the vertex definition. |Name|Type|Description| |---|---|---| |semantic|VertexSemantic| |

function GetElementType(semantic : VertexSemantic) : VertexElementType

GetVertexData : real4

Gets the data of an attribute of a vertex, returns values of 0 if read is invalid. |Name|Type|Description| |---|---|---| |vertexIndex|integer| | |semantic|VertexSemantic| |

function GetVertexData(vertexIndex : Integer, semantic : VertexSemantic) : Real4

GetVertexData : real4

Gets the data of an attribute of a vertex, throws exception if attribute info doesn't match or read is invalid. |Name|Type|Description| |---|---|---| |vertexIndex|integer| | |semantic|VertexSemantic| | |type|VertexElementType| | |count|integer| |

function GetVertexData(vertexIndex : Integer, semantic : VertexSemantic, type : VertexElementType, count : Integer) : Real4

IsValidVertexData : boolean

Returns false if GetVertexData() would throw an exception with the same arguments. |Name|Type|Description| |---|---|---| |vertexIndex|integer| | |semantic|VertexSemantic| | |type|VertexElementType| | |count|integer| |

function IsValidVertexData(vertexIndex : Integer, semantic : VertexSemantic, type : VertexElementType, count : Integer) : Boolean