Sprite Class

previous page next page

SFML.Net

Sprite Class

This class defines a sprite : texture, transformations, color, and draw on screen

Inheritance Hierarchy

SystemObject  SFMLObjectBase
    SFML.GraphicsTransformable
      SFML.GraphicsSprite

Namespace: SFML.Graphics
Assembly: sfmlnet-graphics-2 (in sfmlnet-graphics-2.dll) Version: 2.2.0.0 (2.2.0)

Syntax

public class Sprite : Transformable, Drawable

Public Class Sprite
	Inherits Transformable
	Implements Drawable

public ref class Sprite : public Transformable, 
	Drawable

type Sprite =  
    class
        inherit Transformable
        interface Drawable
    end

The Sprite type exposes the following members.

Constructors

	Name	Description
	Sprite	Default constructor
	Sprite(Sprite)	Construct the sprite from another sprite
	Sprite(Texture)	Construct the sprite from a source texture
	Sprite(Texture, IntRect)	Construct the sprite from a source texture

Methods

	Name	Description
	Destroy	Handle the destruction of the object (Overrides TransformableDestroy(Boolean).)
	Dispose	Explicitely dispose the object (Inherited from ObjectBase.)
	Draw
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Dispose the object (Inherited from ObjectBase.)
	GetGlobalBounds	Get the global bounding rectangle of the entity. The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLocalBounds	Get the local bounding rectangle of the entity. The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Provide a string describing the object (Overrides ObjectToString.)

Properties

	Name	Description
	Color	Global color of the object
	CPointer	Access to the internal pointer of the object. For internal use only (Inherited from ObjectBase.)
	InverseTransform	The combined transform of the object (Inherited from Transformable.)
	Origin	The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). (Inherited from Transformable.)
	Position	Position of the object (Inherited from Transformable.)
	Rotation	Rotation of the object (Inherited from Transformable.)
	Scale	Scale of the object (Inherited from Transformable.)
	Texture	Source texture displayed by the sprite
	TextureRect	Sub-rectangle of the source image displayed by the sprite
	Transform	The combined transform of the object (Inherited from Transformable.)

Remarks

See also the note on coordinates and undistorted rendering in SFML.Graphics.Transformable.

previous page start next page