SpriteFromSheet Class

Namespace: Stride.Rendering.Sprites
Assembly: Stride.Rendering.dll

A sprite provider from a SpriteSheet

System.Object → SpriteFromSheet

Derived from SpriteFromSheet:

[DataContract("SpriteFromSheet")]
[Display("Sprite Group", null)]
public class SpriteFromSheet : IAnimatableSpriteProvider, ISpriteProvider

Name		Description
Properties
	CurrentFrame	Gets or sets the current frame of the animation.
	Sheet	Gets or sets the Sheet of the provider.
	SpritesCount	Gets the number of sprites available in the provider.
Methods
	Create(SpriteSheet, String)	Creates a new instance of SpriteFromSheet with the specified SpriteSheet. CurrentFrame is initialized according to the specified `spriteName`.
	GetSprite()	Get a sprite from the provider.

| Improve this Doc View Source

Gets or sets the current frame of the animation.

[DataMember]
[Display("Default Frame", null)]
public int CurrentFrame { get; set; }

Type	Description
System.Int32

Gets or sets the Sheet of the provider.

[DataMember]
public SpriteSheet Sheet { get; set; }

Type	Description
SpriteSheet

Gets the number of sprites available in the provider.

public int SpritesCount { get; }

Type	Description
System.Int32

| Improve this Doc View Source

Creates a new instance of SpriteFromSheet with the specified SpriteSheet. CurrentFrame is initialized according to the specified spriteName.

public static SpriteFromSheet Create(SpriteSheet sheet, string spriteName)

Type	Name	Description
SpriteSheet	sheet
System.String	spriteName	The name of the sprite.

Type	Description
SpriteFromSheet

If two sprites have the provided name then the first sprite found is used.

Type	Condition
System.ArgumentNullException	sheet
System.Collections.Generic.KeyNotFoundException	No sprite in the sheet has the given name.

Get a sprite from the provider.

public Sprite GetSprite()

Type	Description
Sprite