playcanvas-typings
Version:
TypeScript declaration files for PlayCanvas game engine
51 lines (47 loc) • 2.12 kB
TypeScript
declare namespace pc {
/**
* @name pc.VertexIterator
* @class A vertex iterator simplifies the process of writing vertex data to a vertex buffer.
* @description Returns a new pc.VertexIterator object.
* @param {pc.VertexBuffer} vertexBuffer The vertex buffer to be iterated.
* @author Will Eastcott
*/
class VertexIterator {
constructor(vertexBuffer: pc.VertexBuffer)
/**
* @function
* @name pc.VertexIterator#next
* @description Moves the vertex iterator on to the next vertex.
* @example
* var iterator = new pc.VertexIterator(vertexBuffer);
* iterator.element[pc.SEMANTIC_POSTIION].set(-0.9, -0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(255, 0, 0, 255);
* iterator.next();
* iterator.element[pc.SEMANTIC_POSTIION].set(0.9, -0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(0, 255, 0, 255);
* iterator.next();
* iterator.element[pc.SEMANTIC_POSTIION].set(0.0, 0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(0, 0, 255, 255);
* iterator.end();
*/
next(): void;
/**
* @function
* @name pc.VertexIterator#end
* @description Notifies the vertex buffer being iterated that writes are complete. Internally
* the vertex buffer is unlocked and vertex data is uploaded to video memory.
* @example
* var iterator = new pc.VertexIterator(vertexBuffer);
* iterator.element[pc.SEMANTIC_POSTIION].set(-0.9, -0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(255, 0, 0, 255);
* iterator.next();
* iterator.element[pc.SEMANTIC_POSTIION].set(0.9, -0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(0, 255, 0, 255);
* iterator.next();
* iterator.element[pc.SEMANTIC_POSTIION].set(0.0, 0.9, 0.0);
* iterator.element[pc.SEMANTIC_COLOR].set(0, 0, 255, 255);
* iterator.end();
*/
end(): void;
}
}