C# Class SFML.Graphics.Sprite

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

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

Inheritance: Transformable, Drawable

Show file Open project: SFML/SFML.Net Class Usage Examples

Public Methods

Method	Description
Draw ( RenderTarget target, RenderStates states ) : void	Draw the sprite to a render target
GetGlobalBounds ( ) : FloatRect	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.
GetLocalBounds ( ) : FloatRect	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.
Sprite ( ) : System	Default constructor
Sprite ( Sprite copy ) : System	Construct the sprite from another sprite
Sprite ( Texture texture ) : System	Construct the sprite from a source texture
Sprite ( Texture texture, IntRect rectangle ) : System	Construct the sprite from a source texture
ToString ( ) : string	Provide a string describing the object

Protected Methods

Method	Description
Destroy ( bool disposing ) : void	Handle the destruction of the object

Private Methods

Method	Description
sfRenderTexture_drawSprite ( IntPtr CPointer, IntPtr Sprite, RenderStates &states ) : void
sfRenderWindow_drawSprite ( IntPtr CPointer, IntPtr Sprite, RenderStates &states ) : void
sfSprite_copy ( IntPtr Sprite ) : IntPtr
sfSprite_create ( ) : IntPtr
sfSprite_destroy ( IntPtr CPointer ) : void
sfSprite_getColor ( IntPtr CPointer ) : Color
sfSprite_getLocalBounds ( IntPtr CPointer ) : FloatRect
sfSprite_getTextureRect ( IntPtr CPointer ) : IntRect
sfSprite_setColor ( IntPtr CPointer, Color Color ) : void
sfSprite_setTexture ( IntPtr CPointer, IntPtr Texture, bool AdjustToNewSize ) : void
sfSprite_setTextureRect ( IntPtr CPointer, IntRect Rect ) : void

Method Details

Destroy() protected method

Handle the destruction of the object

protected Destroy ( bool disposing ) : void
disposing	bool	Is the GC disposing the object, or is it an explicit call ?
return	void

Draw() public method

Draw the sprite to a render target

public Draw ( RenderTarget target, RenderStates states ) : void
target	RenderTarget	Render target to draw to
states	RenderStates	Current render states
return	void

GetGlobalBounds() public method

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.

public GetGlobalBounds ( ) : FloatRect
return	FloatRect

GetLocalBounds() public method

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.

public GetLocalBounds ( ) : FloatRect
return	FloatRect

Sprite() public method

Default constructor

public Sprite ( ) : System
return	System

Sprite() public method

Construct the sprite from another sprite

public Sprite ( Sprite copy ) : System
copy	Sprite	Sprite to copy
return	System

Sprite() public method

Construct the sprite from a source texture

public Sprite ( Texture texture ) : System
texture	Texture	Source texture to assign to the sprite
return	System

Sprite() public method

Construct the sprite from a source texture

public Sprite ( Texture texture, IntRect rectangle ) : System
texture	Texture	Source texture to assign to the sprite
rectangle	IntRect	Sub-rectangle of the texture to assign to the sprite
return	System

ToString() public method

Provide a string describing the object

public ToString ( ) : string
return	string