using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using MLEM.Extensions;
namespace MLEM.Graphics {
///
/// A static sprite batch is a variation of that keeps all batched items in a , allowing for them to be drawn multiple times.
/// To add items to a static sprite batch, use to begin batching, to clear currently batched items, Add and its various overloads to add batch items, to remove them again, and to end batching.
/// To draw the batched items, call .
///
public class StaticSpriteBatch : IDisposable {
// this maximum is limited by indices being a short
private const int MaxBatchItems = short.MaxValue / 6;
private static readonly VertexPositionColorTexture[] Data = new VertexPositionColorTexture[MaxBatchItems * 4];
///
/// The amount of vertices that are currently batched
///
public int Vertices => this.items.Count * 4;
private readonly GraphicsDevice graphicsDevice;
private readonly SpriteEffect spriteEffect;
private readonly List vertexBuffers = new List();
private readonly ISet- items = new HashSet
- ();
private IndexBuffer indices;
private Texture2D texture;
private bool batching;
private bool batchChanged;
///
/// Creates a new static sprite batch with the given
///
/// The graphics device to use for rendering
public StaticSpriteBatch(GraphicsDevice graphicsDevice) {
this.graphicsDevice = graphicsDevice;
this.spriteEffect = new SpriteEffect(graphicsDevice);
}
///
/// Begins batching.
/// Call this method before calling Add or any of its overloads.
///
/// Thrown if this batch is currently batching already
public void BeginBatch() {
if (this.batching)
throw new InvalidOperationException("Already batching");
this.batching = true;
}
///
/// Ends batching.
/// Call this method after calling Add or any of its overloads the desired number of times to add batched items.
///
/// The drawing order for sprite drawing. by default. Note that and are not supported.
/// Thrown if this method is called before was called
/// Thrown if the is or , which are not supported
public void EndBatch(SpriteSortMode sortMode = SpriteSortMode.Deferred) {
if (!this.batching)
throw new InvalidOperationException("Not batching");
if (sortMode == SpriteSortMode.Immediate || sortMode == SpriteSortMode.Texture)
throw new ArgumentOutOfRangeException(nameof(sortMode), "Cannot use sprite sort modes Immediate or Texture for static batching");
this.batching = false;
// if we didn't add or remove any batch items, we don't have to recalculate anything
if (!this.batchChanged)
return;
this.batchChanged = false;
// ensure we have enough vertex buffers
var requiredBuffers = (this.items.Count / (float) MaxBatchItems).Ceil();
while (this.vertexBuffers.Count < requiredBuffers)
this.vertexBuffers.Add(new VertexBuffer(this.graphicsDevice, VertexPositionColorTexture.VertexDeclaration, MaxBatchItems * 4, BufferUsage.WriteOnly));
// order items according to the sort mode
IEnumerable
- ordered = this.items;
if (sortMode == SpriteSortMode.BackToFront) {
ordered = ordered.OrderBy(i => -i.Depth);
} else if (sortMode == SpriteSortMode.FrontToBack) {
ordered = ordered.OrderBy(i => i.Depth);
}
// fill vertex buffers
var dataIndex = 0;
var arrayIndex = 0;
foreach (var item in ordered) {
Data[dataIndex++] = item.TopLeft;
Data[dataIndex++] = item.TopRight;
Data[dataIndex++] = item.BottomLeft;
Data[dataIndex++] = item.BottomRight;
if (dataIndex >= Data.Length) {
this.vertexBuffers[arrayIndex++].SetData(Data);
dataIndex = 0;
}
}
if (dataIndex > 0)
this.vertexBuffers[arrayIndex].SetData(Data);
// ensure we have enough indices
var maxItems = Math.Min(this.items.Count, MaxBatchItems);
// each item has 2 triangles which each have 3 indices
if (this.indices == null || this.indices.IndexCount < 6 * maxItems) {
var newIndices = new short[6 * maxItems];
var index = 0;
for (var item = 0; item < maxItems; item++) {
// a square is made up of two triangles
// 0--1
// | /|
// |/ |
// 2--3
// top left triangle (0 -> 1 -> 2)
newIndices[index++] = (short) (item * 4 + 0);
newIndices[index++] = (short) (item * 4 + 1);
newIndices[index++] = (short) (item * 4 + 2);
// bottom right triangle (1 -> 3 -> 2)
newIndices[index++] = (short) (item * 4 + 1);
newIndices[index++] = (short) (item * 4 + 3);
newIndices[index++] = (short) (item * 4 + 2);
}
this.indices?.Dispose();
this.indices = new IndexBuffer(this.graphicsDevice, IndexElementSize.SixteenBits, newIndices.Length, BufferUsage.WriteOnly);
this.indices.SetData(newIndices);
}
}
///
/// Draws this batch's content onto the 's current render target (or the back buffer) with the given settings.
/// Note that this method should not be called while a regular is currently active.
///
/// State of the blending. Uses if null.
/// State of the sampler. Uses if null.
/// State of the depth-stencil buffer. Uses if null.
/// State of the rasterization. Uses if null.
/// A custom to override the default sprite effect. Uses default sprite effect if null.
/// An optional matrix used to transform the sprite geometry. Uses if null.
/// Thrown if this batch is currently batching
public void Draw(BlendState blendState = null, SamplerState samplerState = null, DepthStencilState depthStencilState = null, RasterizerState rasterizerState = null, Effect effect = null, Matrix? transformMatrix = null) {
if (this.batching)
throw new InvalidOperationException("Cannot draw the batch while batching");
this.graphicsDevice.BlendState = blendState ?? BlendState.AlphaBlend;
this.graphicsDevice.SamplerStates[0] = samplerState ?? SamplerState.LinearClamp;
this.graphicsDevice.DepthStencilState = depthStencilState ?? DepthStencilState.None;
this.graphicsDevice.RasterizerState = rasterizerState ?? RasterizerState.CullCounterClockwise;
this.graphicsDevice.Indices = this.indices;
this.spriteEffect.TransformMatrix = transformMatrix;
this.spriteEffect.CurrentTechnique.Passes[0].Apply();
var totalIndex = 0;
foreach (var buffer in this.vertexBuffers) {
var tris = Math.Min(this.items.Count * 4 - totalIndex, buffer.VertexCount) / 4 * 2;
if (tris <= 0)
break;
this.graphicsDevice.SetVertexBuffer(buffer);
if (effect != null) {
foreach (var pass in effect.CurrentTechnique.Passes) {
pass.Apply();
this.graphicsDevice.Textures[0] = this.texture;
this.graphicsDevice.DrawIndexedPrimitives(PrimitiveType.TriangleList, 0, 0, tris);
}
} else {
this.graphicsDevice.Textures[0] = this.texture;
this.graphicsDevice.DrawIndexedPrimitives(PrimitiveType.TriangleList, 0, 0, tris);
}
totalIndex += buffer.VertexCount;
}
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing location on screen.
/// An optional region on the texture which will be rendered. If null - draws full texture.
/// A color mask.
/// A rotation of this sprite.
/// Center of the rotation. 0,0 by default.
/// A scaling of this sprite.
/// Modificators for drawing. Can be combined.
/// A depth of the layer of this sprite.
/// The that was created from the added data
public Item Add(Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth) {
origin *= scale;
Vector2 size, texTl, texBr;
if (sourceRectangle.HasValue) {
var src = sourceRectangle.Value;
size.X = src.Width * scale.X;
size.Y = src.Height * scale.Y;
texTl.X = src.X * (1F / texture.Width);
texTl.Y = src.Y * (1F / texture.Height);
texBr.X = (src.X + src.Width) * (1F / texture.Width);
texBr.Y = (src.Y + src.Height) * (1F / texture.Height);
} else {
size.X = texture.Width * scale.X;
size.Y = texture.Height * scale.Y;
texTl = Vector2.Zero;
texBr = Vector2.One;
}
if ((effects & SpriteEffects.FlipVertically) != 0)
(texBr.Y, texTl.Y) = (texTl.Y, texBr.Y);
if ((effects & SpriteEffects.FlipHorizontally) != 0)
(texBr.X, texTl.X) = (texTl.X, texBr.X);
if (rotation == 0) {
return this.Add(texture, position - origin, size, color, texTl, texBr, layerDepth);
} else {
return this.Add(texture, position, -origin, size, (float) Math.Sin(rotation), (float) Math.Cos(rotation), color, texTl, texBr, layerDepth);
}
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing location on screen.
/// An optional region on the texture which will be rendered. If null - draws full texture.
/// A color mask.
/// A rotation of this sprite.
/// Center of the rotation. 0,0 by default.
/// A scaling of this sprite.
/// Modificators for drawing. Can be combined.
/// A depth of the layer of this sprite.
/// The that was created from the added data
public Item Add(Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color, float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth) {
return this.Add(texture, position, sourceRectangle, color, rotation, origin, new Vector2(scale), effects, layerDepth);
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing bounds on screen.
/// An optional region on the texture which will be rendered. If null - draws full texture.
/// A color mask.
/// A rotation of this sprite.
/// Center of the rotation. 0,0 by default.
/// Modificators for drawing. Can be combined.
/// A depth of the layer of this sprite.
/// The that was created from the added data
public Item Add(Texture2D texture, Rectangle destinationRectangle, Rectangle? sourceRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth) {
Vector2 texTl, texBr;
if (sourceRectangle.HasValue) {
var src = sourceRectangle.Value;
texTl.X = src.X * (1F / texture.Width);
texTl.Y = src.Y * (1F / texture.Height);
texBr.X = (src.X + src.Width) * (1F / texture.Width);
texBr.Y = (src.Y + src.Height) * (1F / texture.Height);
origin.X = origin.X * destinationRectangle.Width * (src.Width != 0 ? src.Width : 1F / texture.Width);
origin.Y = origin.Y * destinationRectangle.Height * (src.Height != 0 ? src.Height : 1F / texture.Height);
} else {
texTl = Vector2.Zero;
texBr = Vector2.One;
origin.X = origin.X * destinationRectangle.Width * (1F / texture.Width);
origin.Y = origin.Y * destinationRectangle.Height * (1F / texture.Height);
}
if ((effects & SpriteEffects.FlipVertically) != 0)
(texBr.Y, texTl.Y) = (texTl.Y, texBr.Y);
if ((effects & SpriteEffects.FlipHorizontally) != 0)
(texBr.X, texTl.X) = (texTl.X, texBr.X);
if (rotation == 0) {
return this.Add(texture, destinationRectangle.Location.ToVector2() - origin, destinationRectangle.Size.ToVector2(), color, texTl, texBr, layerDepth);
} else {
return this.Add(texture, destinationRectangle.Location.ToVector2(), -origin, destinationRectangle.Size.ToVector2(), (float) Math.Sin(rotation), (float) Math.Cos(rotation), color, texTl, texBr, layerDepth);
}
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing location on screen.
/// An optional region on the texture which will be rendered. If null - draws full texture.
/// A color mask.
/// The that was created from the added data
public Item Add(Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color) {
return this.Add(texture, position, sourceRectangle, color, 0, Vector2.Zero, 1, SpriteEffects.None, 0);
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing bounds on screen.
/// An optional region on the texture which will be rendered. If null - draws full texture.
/// A color mask.
/// The that was created from the added data
public Item Add(Texture2D texture, Rectangle destinationRectangle, Rectangle? sourceRectangle, Color color) {
return this.Add(texture, destinationRectangle, sourceRectangle, color, 0, Vector2.Zero, SpriteEffects.None, 0);
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing location on screen.
/// A color mask.
/// The that was created from the added data
public Item Add(Texture2D texture, Vector2 position, Color color) {
return this.Add(texture, position, null, color);
}
///
/// Adds an item to this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// A texture.
/// The drawing bounds on screen.
/// A color mask.
/// The that was created from the added data
public Item Add(Texture2D texture, Rectangle destinationRectangle, Color color) {
return this.Add(texture, destinationRectangle, null, color);
}
///
/// Removes the given item from this batch.
/// Note that this batch needs to currently be batching, meaning has to have been called previously.
///
/// The item to remove
/// Whether the item was successfully removed
/// Thrown if this method is called before was called
public bool Remove(Item item) {
if (!this.batching)
throw new InvalidOperationException("Not batching");
if (this.items.Remove(item)) {
this.batchChanged = true;
return true;
}
return false;
}
///
/// Clears the batch, removing all currently batched vertices.
/// After this operation, will return 0.
///
/// Thrown if this method is called before was called
public void ClearBatch() {
if (!this.batching)
throw new InvalidOperationException("Not batching");
this.items.Clear();
this.texture = null;
this.batchChanged = true;
}
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose() {
this.spriteEffect.Dispose();
this.indices?.Dispose();
foreach (var buffer in this.vertexBuffers)
buffer.Dispose();
GC.SuppressFinalize(this);
}
private Item Add(Texture2D texture, Vector2 pos, Vector2 offset, Vector2 size, float sin, float cos, Color color, Vector2 texTl, Vector2 texBr, float depth) {
return this.Add(texture, depth,
new VertexPositionColorTexture(new Vector3(pos.X + offset.X * cos - offset.Y * sin, pos.Y + offset.X * sin + offset.Y * cos, depth), color, texTl),
new VertexPositionColorTexture(new Vector3(pos.X + (offset.X + size.X) * cos - offset.Y * sin, pos.Y + (offset.X + size.X) + offset.Y * cos, depth), color, new Vector2(texBr.X, texTl.Y)),
new VertexPositionColorTexture(new Vector3(pos.X + offset.X * cos - (offset.Y + size.Y) * sin, pos.Y + offset.X * sin + (offset.Y + size.Y) * cos, depth), color, new Vector2(texTl.X, texBr.Y)),
new VertexPositionColorTexture(new Vector3(pos.X + (offset.X + size.X) * cos - (offset.Y + size.Y) * sin, pos.Y + (offset.X + size.X) * sin + (offset.Y + size.Y) * cos, depth), color, texBr));
}
private Item Add(Texture2D texture, Vector2 pos, Vector2 size, Color color, Vector2 texTl, Vector2 texBr, float depth) {
return this.Add(texture, depth,
new VertexPositionColorTexture(new Vector3(pos, depth), color, texTl),
new VertexPositionColorTexture(new Vector3(pos.X + size.X, pos.Y, depth), color, new Vector2(texBr.X, texTl.Y)),
new VertexPositionColorTexture(new Vector3(pos.X, pos.Y + size.Y, depth), color, new Vector2(texTl.X, texBr.Y)),
new VertexPositionColorTexture(new Vector3(pos.X + size.X, pos.Y + size.Y, depth), color, texBr));
}
private Item Add(Texture2D texture, float depth, VertexPositionColorTexture tl, VertexPositionColorTexture tr, VertexPositionColorTexture bl, VertexPositionColorTexture br) {
if (!this.batching)
throw new InvalidOperationException("Not batching");
if (this.texture != null && this.texture != texture)
throw new ArgumentException("Cannot use multiple textures in one batch", nameof(texture));
var item = new Item(tl, tr, bl, br, depth);
this.items.Add(item);
this.texture = texture;
this.batchChanged = true;
return item;
}
///
/// A struct that represents an item added to a using Add or any of its overloads.
/// An item returned after adding can be removed using .
///
public class Item {
internal readonly VertexPositionColorTexture TopLeft;
internal readonly VertexPositionColorTexture TopRight;
internal readonly VertexPositionColorTexture BottomLeft;
internal readonly VertexPositionColorTexture BottomRight;
internal readonly float Depth;
internal Item(VertexPositionColorTexture topLeft, VertexPositionColorTexture topRight, VertexPositionColorTexture bottomLeft, VertexPositionColorTexture bottomRight, float depth) {
this.TopLeft = topLeft;
this.TopRight = topRight;
this.BottomLeft = bottomLeft;
this.BottomRight = bottomRight;
this.Depth = depth;
}
}
}
}