Struct sfml::graphics::Sprite

pub struct Sprite<'s> { /* private fields */ }

Drawable representation of a texture

Sprite is a drawable type that allows to easily display a Texture (or a part of it) on a render target.

Note: Currently, it is not feasible to store sprites long term. A common pattern with rust-sfml is to create a Sprite right before you start drawing, and draw all the sprites you want with it. You can change its properties using set_texture, set_position, etc., before drawing it, as many times as you need to.

Implementations

impl<'s> Sprite<'s>

pub fn new() -> Sprite<'s>

Create a new sprite

pub fn with_texture(texture: &'s Texture) -> Sprite<'s>

Create a new sprite with a texture

pub fn with_texture_and_rect(texture: &'s Texture, rect: &IntRect) -> Self

Create a new sprite with a texture and a source rectangle

pub fn set_texture(&mut self, texture: &'s Texture, reset_rect: bool)

Change the source texture of a sprite

The texture argument refers to a texture that must exist as long as the sprite uses it. Indeed, the sprite doesn’t store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the sprite tries to use it, the behaviour is undefined. If reset_rect is true, the texture_rect property of the sprite is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.

Arguments

• texture - New texture
• reset_rect - Should the texture rect be reset to the size of the new texture?

pub fn disable_texture(&mut self)

Disable Texturing

Disable the current texture and reset the texture rect

pub fn set_color(&mut self, color: Color)

Set the global color of a sprite

This color is modulated (multiplied) with the sprite’s texture. It can be used to colorize the sprite, or change its global opacity. By default, the sprite’s color is opaque white.

Arguments

• color - New color of the sprite

pub fn texture(&self) -> Option<&'s Texture>

Get the source texture of a sprite

If the sprite has no source texture, None is returned. You can’t modify the texture when you retrieve it with this function.

Return an Option to the sprite’s texture

pub fn color(&self) -> Color

Get the global color of a sprite

Return the global color of the sprite

pub fn local_bounds(&self) -> FloatRect

Get the local bounding rectangle of a sprite

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.

Return the local bounding rectangle of the entity

pub fn global_bounds(&self) -> FloatRect

Get the global bounding rectangle of a sprite

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.

Return the global bounding rectangle of the entity

pub fn texture_rect(&self) -> IntRect

Get the sub-rectangle of the texture displayed by a sprite

Return the texture rectangle of the sprite

pub fn set_texture_rect(&mut self, rect: &IntRect)

Set the sub-rectangle of the texture that a sprite will display

The texture rect is useful when you don’t want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.

Arguments

• rectangle - Rectangle defining the region of the texture to display

Trait Implementations

impl<'s> Clone for Sprite<'s>

fn clone(&self) -> Sprite<'s>

Return a new Sprite or panic! if there is not enough memory

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'s> Debug for Sprite<'s>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'s> Default for Sprite<'s>

fn default() -> Self

Returns the “default value” for a type.

impl<'s> Drawable for Sprite<'s>

fn draw<'a: 'shader, 'texture, 'shader, 'shader_texture>(
    &'a self,
    target: &mut dyn RenderTarget,
    states: &RenderStates<'texture, 'shader, 'shader_texture>
)

Draws into target with RenderStates states.

impl<'s> Drop for Sprite<'s>

fn drop(&mut self)

Executes the destructor for this type.

impl<'s> Transformable for Sprite<'s>

fn set_position<P: Into<Vector2f>>(&mut self, position: P)

Sets the position of the object.

fn set_rotation(&mut self, angle: f32)

Set the orientation of the object.

fn set_scale<S: Into<Vector2f>>(&mut self, scale: S)

Sets the scale factors of the object.

fn set_origin<O: Into<Vector2f>>(&mut self, origin: O)

Sets the local origin of the object.

fn position(&self) -> Vector2f

Gets the position of the object.

fn rotation(&self) -> f32

Gets the rotation of the object.

fn get_scale(&self) -> Vector2f

Gets the current scale of the object.

fn origin(&self) -> Vector2f

Gets the local origin of the object.

fn move_<O: Into<Vector2f>>(&mut self, offset: O)

Moves the object by a given offset.

fn rotate(&mut self, angle: f32)

Rotates the object.

fn scale<F: Into<Vector2f>>(&mut self, factors: F)

Scales the object.

fn transform(&self) -> &Transform

Gets the combined transform of the object.

fn inverse_transform(&self) -> &Transform

Gets the inverse combined transform of the object.