IDrawable Interface

Namespace: Stride.Games
Assembly: Stride.Games.dll

An interface for a drawable game component that is called by the GameBase class.

public interface IDrawable

Name		Description
Properties
	DrawOrder	Gets the draw order relative to other objects. IDrawable objects with a lower value are drawn first.
	Visible	Gets a value indicating whether the Draw(GameTime) method should be called by Draw(GameTime).
Methods
	BeginDraw()	Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw.
	Draw(GameTime)	Draws this instance.
	EndDraw()	Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.
Events
	DrawOrderChanged	Occurs when the DrawOrder property changes.
	VisibleChanged	Occurs when the Visible property changes.

| Improve this Doc View Source

Gets the draw order relative to other objects. IDrawable objects with a lower value are drawn first.

int DrawOrder { get; }

Type	Description
System.Int32	The draw order.

Gets a value indicating whether the Draw(GameTime) method should be called by Draw(GameTime).

bool Visible { get; }

Type	Description
System.Boolean	`true` if this drawable component is visible; otherwise, `false`.

| Improve this Doc View Source

Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw.

bool BeginDraw()

Type	Description
System.Boolean	`true` if Draw should occur, `false` otherwise

Draws this instance.

void Draw(GameTime gameTime)

Type	Name	Description
GameTime	gameTime	The current timing.

Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.

void EndDraw()

| Improve this Doc View Source

Occurs when the DrawOrder property changes.

event EventHandler<EventArgs> DrawOrderChanged

Type	Description
System.EventHandler<System.EventArgs>

Occurs when the Visible property changes.

event EventHandler<EventArgs> VisibleChanged

Type	Description
System.EventHandler<System.EventArgs>