C# Class Microsoft.Xna.Framework.Graphics.SpriteBatcher

Show file Open project: procfxgen/MGShaderEditor Class Usage Examples

Public Methods

Method Description
CreateBatchItem ( ) : SpriteBatchItem

Create an instance of SpriteBatchItem if there is none available in the free item queue. Otherwise, a previously allocated SpriteBatchItem is reused.

DrawBatch ( SpriteSortMode sortMode, Effect effect ) : void

Sorts the batch items and then groups batch drawing into maximal allowed batch sets that do not overflow the 16 bit array indices for vertices.

SpriteBatcher ( GraphicsDevice device ) : System.Collections.Generic

Private Methods

Method Description
CompareDepth ( SpriteBatchItem a, SpriteBatchItem b ) : int

Compares the Depth of a against b returning -1 if a is less than b, 0 if equal, and 1 if a is greater than b. The test uses float.CompareTo(float)

CompareReverseDepth ( SpriteBatchItem a, SpriteBatchItem b ) : int

Implements the opposite of CompareDepth, where b is compared against a.

CompareTexture ( SpriteBatchItem a, SpriteBatchItem b ) : int

Comparison of the underlying Texture objects for each given SpriteBatchitem.

EnsureArrayCapacity ( int numBatchItems ) : void

Resize and recreate the missing indices for the index and vertex position color buffers.

FlushVertexArray ( int start, int end, Effect effect, Texture texture ) : void

Sends the triangle list to the graphics device. Here is where the actual drawing starts.

Method Details

CreateBatchItem() public method

Create an instance of SpriteBatchItem if there is none available in the free item queue. Otherwise, a previously allocated SpriteBatchItem is reused.
public CreateBatchItem ( ) : SpriteBatchItem
return SpriteBatchItem

DrawBatch() public method

Sorts the batch items and then groups batch drawing into maximal allowed batch sets that do not overflow the 16 bit array indices for vertices.
public DrawBatch ( SpriteSortMode sortMode, Effect effect ) : void
sortMode SpriteSortMode The type of depth sorting desired for the rendering.
effect Effect The custom effect to apply to the drawn geometry
return void

SpriteBatcher() public method

public SpriteBatcher ( GraphicsDevice device ) : System.Collections.Generic
device GraphicsDevice
return System.Collections.Generic