starling-framework/lib/starling/rendering/BatchToken.d.ts

A fast, productive library for 2D cross-platform development.

declare namespace starling.rendering {
	/**
	 *  Points to a location within a list of MeshBatches.
	 *  *
	 *  *  <p>Starling uses these tokens in its render cache. Each call to
	 *  *  <code>painter.pushState()</code> or <code>painter.popState()</code> provides a token
	 *  *  referencing the current location within the cache. In the next frame, if the relevant
	 *  *  part of the display tree has not changed, these tokens can be used to render directly
	 *  *  from the cache instead of constructing new MeshBatches.</p>
	 *  *
	 *  *  @see Painter
	 *  
	 */
	export class BatchToken {
		/**
		 *  Creates a new BatchToken. 
		 */
		constructor(batchID?: number, vertexID?: number, indexID?: number);
		/**
		 *  The ID of the current MeshBatch. 
		 */
		batchID: number;
		/**
		 *  The ID of the next vertex within the current MeshBatch. 
		 */
		vertexID: number;
		/**
		 *  The ID of the next index within the current MeshBatch. 
		 */
		indexID: number;
		/**
		 *  Copies the properties from the given token to this instance. 
		 */
		copyFrom(token: BatchToken): void;
		/**
		 *  Changes all properties at once. 
		 */
		setTo(batchID?: number, vertexID?: number, indexID?: number): void;
		/**
		 *  Resets all properties to zero. 
		 */
		reset(): void;
		/**
		 *  Indicates if this token contains the same values as the given one. 
		 */
		equals(other: BatchToken): boolean;
		/**
		 *  Creates a String representation of this instance. 
		 */
		toString(): string;
	}
}
export default starling.rendering.BatchToken;