Class SceneSystem

Namespace

Stride.Engine

Assembly

Stride.Engine.dll

The scene system handles the scenes of a game.

public class SceneSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable

Inheritance

object

DisposeBase

ComponentBase

GameSystemBase

SceneSystem

Implements

IDisposable

ICollectorHolder

IGameSystemBase

IComponent

IReferencable

IUpdateable

IDrawable

IContentable

Inherited Members

GameSystemBase.Game

GameSystemBase.Services

GameSystemBase.Content

GameSystemBase.GraphicsDevice

GameSystemBase.DrawOrderChanged

GameSystemBase.VisibleChanged

GameSystemBase.BeginDraw()

GameSystemBase.EndDraw()

GameSystemBase.Visible

GameSystemBase.DrawOrder

GameSystemBase.Initialize()

GameSystemBase.InitializeGraphicsDeviceService()

GameSystemBase.EnabledChanged

GameSystemBase.UpdateOrderChanged

GameSystemBase.Enabled

GameSystemBase.UpdateOrder

GameSystemBase.OnDrawOrderChanged(object, EventArgs)

GameSystemBase.OnUpdateOrderChanged(object, EventArgs)

GameSystemBase.UnloadContent()

ComponentBase.Tags

ComponentBase.Name

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.IsDisposed

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

UnsafeUtilities.As<T>(object?)

Constructors

SceneSystem(IServiceRegistry)

Initializes a new instance of the GameSystemBase class.

public SceneSystem(IServiceRegistry registry)

Parameters

registry IServiceRegistry

The registry.

Remarks

The GameSystem is expecting the following services to be registered: IGame and IContentManager.

Properties

DoubleViewSplashScreen

Is the splash screen displayed in VR double view.

public bool DoubleViewSplashScreen { get; set; }

Property Value

bool

GraphicsCompositor

public GraphicsCompositor GraphicsCompositor { get; set; }

Property Value

GraphicsCompositor

InitialGraphicsCompositorUrl

URL of the graphics compositor loaded at initialization.

public string InitialGraphicsCompositorUrl { get; set; }

Property Value

string

InitialSceneUrl

URL of the scene loaded at initialization.

public string InitialSceneUrl { get; set; }

Property Value

string

SceneInstance

Gets or sets the root scene.

public SceneInstance SceneInstance { get; set; }

Property Value

SceneInstance

The scene

Exceptions

ArgumentNullException

Scene cannot be null

SplashScreenColor

Splash screen background color.

public Color4 SplashScreenColor { get; set; }

Property Value

Color4

SplashScreenEnabled

If splash screen rendering is enabled, true if a splash screen texture is present, and only in release builds

public bool SplashScreenEnabled { get; set; }

Property Value

bool

SplashScreenUrl

URL of the splash screen texture loaded at initialization.

public string SplashScreenUrl { get; set; }

Property Value

string

Methods

Destroy()

Disposes the object's resources.

protected override void Destroy()

Remarks

Override in a derived class to implement disposal logic specific to it.

This method is automatically called whenever a call to Dispose() (or to Release()) has decreased the internal reference count to zero, meaning no other objects (hopefully) hold a reference to this one and its resources can be safely released.

Draw(GameTime)

Draws the Game Component.

public override void Draw(GameTime gameTime)

Parameters

gameTime GameTime

The current timing information.

LoadContent()

protected override void LoadContent()

Update(GameTime)

This method is called when this game component is updated.

public override void Update(GameTime gameTime)

Parameters

gameTime GameTime

The current timing.