Sprite

Object Hierarchy:

Description:

[ Compact ]
[ CCode ( cname = "sfSprite" , copy_function = "sfSprite_copy" , free_function = "sfSprite_destroy" ) ]
public class Sprite : Shape

Class representing a sprite, which is an object that can be drawn to the screen

A sprite is a graphical object that can be drawn to the screen. It has a texture which is the image that is displayed, and a position, which determines where the sprite is drawn. Sprites can also be rotated, scaled, and have their color changed.

Most (if not all) of you are already familiar with these two very common objects, so let's define them very briefly.

A texture is an image. But we call it "texture" because it has a very specific role: being mapped to a 2D entity.

A sprite is nothing more than a textured rectangle.

Ok, that was short but if you really don't understand what sprites and textures are, then you'll find a much better description on Wikipedia.

// Declare and load a texture
var texture = new texture.fromFile("texture.png");

// Create a sprite
var sprite = new Sprite();
sprite.setTexture(texture);
sprite.setTextureRect(IntRect(10, 10, 50, 30));
sprite.setColor(Color(255, 255, 255, 200));
sprite.setPosition(100, 25);

// Draw it
sprite.draw(window);

Namespace: sf

Package: sfml

Content:

Properties:

public float angle { get; set; }
public Color color { get; set; }
property to change global color of the sprite.
public FloatRect globalBounds { get; set; }
public FloatRect localBounds { get; set; }
public Vector2f origin { get; set; }
property of the local origin of the object
public Vector2f position { get; set; }
property of the position of the object
public float rotation { get; set; }
property of the orientation of the object
public Vector2f scale { get; set; }
property of the current scale of the object
public unowned Texture texture { get; set; }
public IntRect textureRect { get; set; }

Creation methods:

public Sprite ()

Methods:

public Sprite copy ()
Create a copy of the current Sprite object.
public void draw (RenderWindow window, RenderStates? state = null)
Draw the sprite to the render window.
public Color getColor ()
Get the global color of the sprite.
public FloatRect getGlobalBounds ()
Get the global bounds of the sprite.
public Transform getInverseTransform ()
get the inverse of the combined transform of the object
public FloatRect getLocalBounds ()
Get the local bounds of the sprite.
public Vector2f getOrigin ()
get the local origin of the object
public Vector2f getPosition ()
get the position of the object
public float getRotation ()
property of the orientation of the object
public Vector2f getScale ()
get the current scale of the object
public unowned Texture getTexture ()
Get the texture of the sprite.
public IntRect getTextureRect ()
Get the texture rectangle of the sprite.
public Transform getTransform ()
get the combined transform of the object
public void move (Vector2f offset)
Move the object by a given offset.
public void rotate (float angle)
Rotate the object.
public void scaling (Vector2f factors)
Scale the object.
public void setColor (Color color)
Set the global color of the sprite.
public void setOrigin (Vector2f origin)
set the local origin of the object
public void setPosition (Vector2f position)
set the position of the object
public void setRotation (float angle)
set the orientation of the object
public void setScale (Vector2f scale)
set the scale factors of the object
public void setTexture (Texture texture, bool resetRect = false)
Set the texture of the sprite.
public void setTextureRect (IntRect rectangle)
Set the texture rectangle of the sprite.

Inherited Members:

All known members inherited from class sf.Shape

All known members inherited from class sf.Transformable