SiliconStudio.Paradox.Games.IDrawable Interface Reference

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

Inheritance diagram for SiliconStudio.Paradox.Games.IDrawable:

Public Member Functions
bool	BeginDraw ()
	Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw. More...
void	Draw (GameTime gameTime)
	Draws this instance. More...
void	EndDraw ()
	Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw. More...

Properties
bool	Visible [get]
	Gets a value indicating whether the Draw method should be called by GameBase.Draw. More...
int	DrawOrder [get]
	Gets the draw order relative to other objects. IDrawable objects with a lower value are drawn first. More...

Events
EventHandler< EventArgs >	DrawOrderChanged
	Occurs when the DrawOrder property changes. More...
EventHandler< EventArgs >	VisibleChanged
	Occurs when the Visible property changes. More...

Detailed Description

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

Definition at line 30 of file IDrawable.cs.

Member Function Documentation

bool SiliconStudio.Paradox.Games.IDrawable.BeginDraw

(

)

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

Returns

true if Draw should occur, false otherwise

Implemented in SiliconStudio.Paradox.Games.GameWindowRenderer, and SiliconStudio.Paradox.Games.GameSystemBase.

void SiliconStudio.Paradox.Games.IDrawable.Draw

(

GameTime

gameTime

)

Draws this instance.

Parameters

gameTime

The current timing.

Implemented in SiliconStudio.Paradox.Graphics.Regression.FrameGameSystem, SiliconStudio.Paradox.Games.GameSystemBase, SiliconStudio.Paradox.Effects.RenderSystem, SiliconStudio.Paradox.EntityModel.EntitySystem, and SiliconStudio.Paradox.Engine.SpriteAnimationSystem.

void SiliconStudio.Paradox.Games.IDrawable.EndDraw

(

)

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

Implemented in SiliconStudio.Paradox.Games.GameWindowRenderer, and SiliconStudio.Paradox.Games.GameSystemBase.

Property Documentation

int SiliconStudio.Paradox.Games.IDrawable.DrawOrder

get

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

The draw order.

Definition at line 69 of file IDrawable.cs.

bool SiliconStudio.Paradox.Games.IDrawable.Visible

get

Gets a value indicating whether the Draw method should be called by GameBase.Draw.

true if this drawable component is visible; otherwise, false.

Definition at line 63 of file IDrawable.cs.

Event Documentation

EventHandler<EventArgs> SiliconStudio.Paradox.Games.IDrawable.DrawOrderChanged

Occurs when the DrawOrder property changes.

Definition at line 35 of file IDrawable.cs.

EventHandler<EventArgs> SiliconStudio.Paradox.Games.IDrawable.VisibleChanged

Occurs when the Visible property changes.

Definition at line 40 of file IDrawable.cs.

---

The documentation for this interface was generated from the following file:

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Games/IDrawable.cs