#region CPL License
/*
Nuclex Framework
Copyright (C) 2002-2009 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion

using System;
using System.Collections.Generic;
using System.Text;

using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Content;
using Microsoft.Xna.Framework.Graphics;

namespace Nuclex.Ninject.Xna {

  /// <summary>Interface for XNA's sprite batch class</summary>
  public interface ISpriteBatch {

    /// <summary>
    ///   Prepares the graphics device for drawing sprites. Reference page contains
    ///   links to related code samples.
    /// </summary>
    void Begin();

    /// <summary>
    ///   Begins a sprite batch operation using the specified sort and blend state
    ///   object and default state objects (DepthStencilState.None, SamplerState.LinearClamp,
    ///   RasterizerState.CullCounterClockwise). If you pass a null blend state, the
    ///   default is BlendState.AlphaBlend.
    /// </summary>
    /// <param name="sortMode">Sprite drawing order</param>
    /// <param name="blendState">Blending options</param>
    void Begin(SpriteSortMode sortMode, BlendState blendState);

    /// <summary>
    ///   Begins a sprite batch operation using the specified sort, blend, sampler,
    ///   depth stencil and rasterizer state objects. Passing null for any of the state
    ///   objects selects the default default state objects (BlendState.AlphaBlend,
    ///   SamplerState.LinearClamp, DepthStencilState.None,
    ///   RasterizerState.CullCounterClockwise).
    /// </summary>
    /// <param name="sortMode">Sprite drawing order</param>
    /// <param name="blendState">Blending options</param>
    /// <param name="samplerState">Texture sampling options</param>
    /// <param name="depthStencilState">Depth and stencil options</param>
    /// <param name="rasterizerState">Rasterization options</param>
    void Begin(
      SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState,
      DepthStencilState depthStencilState, RasterizerState rasterizerState
    );

    /// <summary>
    ///   Begins a sprite batch operation using the specified sort, blend, sampler,
    ///   depth stencil and rasterizer state objects, plus a custom effect. Passing
    ///   null for any of the state objects selects the default default state objects
    ///   (BlendState.AlphaBlend, DepthStencilState.None,
    ///   RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing
    ///   a null effect selects the default SpriteBatch Class shader.
    /// </summary>
    /// <param name="sortMode">Sprite drawing order</param>
    /// <param name="blendState">Blending options</param>
    /// <param name="samplerState">Texture sampling options</param>
    /// <param name="depthStencilState">Depth and stencil options</param>
    /// <param name="rasterizerState">Rasterization options</param>
    /// <param name="effect">Effect state options</param>
    void Begin(
      SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState,
      DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect
    );

    /// <summary>
    ///   Begins a sprite batch operation using the specified sort, blend, sampler,
    ///   depth stencil, rasterizer state objects, plus a custom effect and a 2D
    ///   transformation matrix. Passing null for any of the state objects selects
    ///   the default default state objects (BlendState.AlphaBlend, DepthStencilState.None,
    ///   RasterizerState.CullCounterClockwise, SamplerState.LinearClamp). Passing
    ///   a null effect selects the default SpriteBatch Class shader.
    /// </summary>
    /// <param name="sortMode">Sprite drawing order</param>
    /// <param name="blendState">Blending options</param>
    /// <param name="samplerState">Texture sampling options</param>
    /// <param name="depthStencilState">Depth and stencil options</param>
    /// <param name="rasterizerState">Rasterization options</param>
    /// <param name="effect">Effect state options</param>
    /// <param name="transformMatrix">
    ///   Transformation matrix for scale, rotate, translate options
    /// </param>
    void Begin(
      SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState,
      DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect,
      Matrix transformMatrix
    );

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   destination rectangle, and color tint. Reference page contains links to related
    ///   code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="destinationRectangle">
    ///   A rectangle specifying, in screen coordinates, where the sprite will be drawn.
    ///   If this rectangle is not the same size as sourcerectangle, the sprite is
    ///   scaled to fit.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting
    /// </param>
    void Draw(Texture2D texture, Rectangle destinationRectangle, Color color);

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   screen position, and color tint. Reference page contains links to related
    ///   code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the sprite will be drawn
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    void Draw(Texture2D texture, Vector2 position, Color color);

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   destination and source rectangles, and color tint. Reference page contains
    ///   links to related code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="destinationRectangle">
    ///   A rectangle specifying, in screen coordinates, where the sprite will be drawn.
    ///   If this rectangle is not the same size as sourcerectangle the sprite will
    ///   be scaled to fit.
    /// </param>
    /// <param name="sourceRectangle">
    ///   A rectangle specifying, in texels, which section of the rectangle to draw.
    ///   Use null to draw the entire texture.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    void Draw(
      Texture2D texture, Rectangle destinationRectangle, Rectangle? sourceRectangle,
      Color color
    );

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   screen position, source rectangle, and color tint. Reference page contains
    ///   links to related code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the sprite will be drawn
    /// </param>
    /// <param name="sourceRectangle">
    ///   A rectangle specifying, in texels, which section of the rectangle to draw.
    ///   Use null to draw the entire texture.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    void Draw(Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color);

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   destination, and source rectangles, color tint, rotation, origin, effects,
    ///   and sort depth. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="destinationRectangle">
    ///   A rectangle specifying, in screen coordinates, where the sprite will be drawn.
    ///   If this rectangle is not the same size as sourceRectangle, the sprite is
    ///   scaled to fit.
    /// </param>
    /// <param name="sourceRectangle">
    ///   A rectangle specifying, in texels, which section of the rectangle to draw.
    ///   Use null to draw the entire texture.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the sprite around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the sprite. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back). You must
    ///   specify either SpriteSortMode.FrontToBack or SpriteSortMode.BackToFront for
    ///   this parameter to affect sprite drawing.
    /// </param>
    void Draw(
      Texture2D texture, Rectangle destinationRectangle, Rectangle? sourceRectangle,
      Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   screen position, optional source rectangle, color tint, rotation, origin,
    ///   scale, effects, and sort depth. Reference page contains links to related
    ///   code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the sprite will be drawn
    /// </param>
    /// <param name="sourceRectangle">
    ///   A rectangle specifying, in texels, which section of the rectangle to draw.
    ///   Use null to draw the entire texture.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the sprite around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the sprite. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Uniform multiple by which to scale the sprite width and height
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back). You must
    ///   specify either SpriteSortMode.FrontToBack or SpriteSortMode.BackToFront for
    ///   this parameter to affect sprite drawing.
    /// </param>
    void Draw(
      Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color,
      float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a sprite to the batch of sprites to be rendered, specifying the texture,
    ///   screen position, source rectangle, color tint, rotation, origin, scale, effects,
    ///   and sort depth. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="texture">The sprite texture</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the sprite will be drawn
    /// </param>
    /// <param name="sourceRectangle">
    ///   A rectangle specifying, in texels, which section of the rectangle to draw.
    ///   Use null to draw the entire texture.
    /// </param>
    /// <param name="color">
    ///   The color channel modulation to use. Use Color.White for full color with
    ///   no tinting.
    /// </param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the sprite around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the sprite. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Vector containing separate scalar multiples for the x- and y-axes of
    ///   the sprite.
    /// </param>
    /// <param name="effects">Rotations to apply before rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back). You must
    ///   specify either SpriteSortMode.FrontToBack or SpriteSortMode.BackToFront for
    ///   this parameter to affect sprite drawing.
    /// </param>
    void Draw(
      Texture2D texture, Vector2 position, Rectangle? sourceRectangle, Color color,
      float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a sprite string to the batch of sprites to be rendered, specifying the
    ///   font, output text, screen position, and color tint. Reference page contains
    ///   links to related code samples.
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    void DrawString(SpriteFont spriteFont, string text, Vector2 position, Color color);

    /// <summary>
    ///   Adds a mutable sprite string to the batch of sprites to be rendered, specifying
    ///   the font, output text, screen position, and color tint. Reference page contains
    ///   links to related code samples
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The mutable (read/write) string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    void DrawString(SpriteFont spriteFont, StringBuilder text, Vector2 position, Color color);

    /// <summary>
    ///   Adds a sprite string to the batch of sprites to be rendered, specifying the
    ///   font, output text, screen position, color tint, rotation, origin, scale,
    ///   and effects. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the text around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the string. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Uniform multiple by which to scale the sprite width and height
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back)
    /// </param>
    void DrawString(
      SpriteFont spriteFont, string text, Vector2 position, Color color, float rotation,
      Vector2 origin, float scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a sprite string to the batch of sprites to be rendered, specifying the
    ///   font, output text, screen position, color tint, rotation, origin, scale,
    ///   effects, and depth. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the text around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the string. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Vector containing separate scalar multiples for the x- and y-axes of
    ///   the sprite
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back)
    /// </param>
    void DrawString(
      SpriteFont spriteFont, string text, Vector2 position, Color color, float rotation,
      Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a mutable sprite string to the batch of sprites to be rendered, specifying
    ///   the font, output text, screen position, color tint, rotation, origin, scale,
    ///   and effects. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The mutable (read/write) string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the text around the origin.
    /// </param>
    /// <param name="origin">
    ///   The origin of the string. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Uniform multiple by which to scale the sprite width and height
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back)
    /// </param>
    void DrawString(
      SpriteFont spriteFont, StringBuilder text, Vector2 position, Color color,
      float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Adds a mutable sprite string to the batch of sprites to be rendered, specifying
    ///   the font, output text, screen position, color tint, rotation, origin, scale,
    ///   effects, and depth. Reference page contains links to related code samples.
    /// </summary>
    /// <param name="spriteFont">The sprite font</param>
    /// <param name="text">The mutable (read/write) string to draw</param>
    /// <param name="position">
    ///   The location, in screen coordinates, where the text will be drawn
    /// </param>
    /// <param name="color">The desired color of the text</param>
    /// <param name="rotation">
    ///   The angle, in radians, to rotate the text around the origin
    /// </param>
    /// <param name="origin">
    ///   The origin of the string. Specify (0,0) for the upper-left corner.
    /// </param>
    /// <param name="scale">
    ///   Vector containing separate scalar multiples for the x- and y-axes of
    ///   the sprite.
    /// </param>
    /// <param name="effects">Rotations to apply prior to rendering</param>
    /// <param name="layerDepth">
    ///   The sorting depth of the sprite, between 0 (front) and 1 (back)
    /// </param>
    void DrawString(
      SpriteFont spriteFont, StringBuilder text, Vector2 position, Color color,
      float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth
    );

    /// <summary>
    ///   Flushes the sprite batch and restores the device state to how it was before
    ///   Begin was called. Reference page contains links to related code samples.
    /// </summary>
    void End();

  }

} // namespace Nuclex.Ninject.Xna