Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    SceneSystem Class

    Namespace: Stride.Engine
    Assembly: Stride.Engine.dll

    The scene system handles the scenes of a game.

    System.Object → DisposeBase → ComponentBase → GameSystemBase → SceneSystem
    Derived from SceneSystem:

    public class SceneSystem : GameSystemBase, IDisposable, ICollectorHolder, IGameSystemBase, IComponent, IReferencable, IUpdateable, IDrawable, IContentable
    Name Description
    Constructors
    SceneSystem(IServiceRegistry)

    Initializes a new instance of the GameSystemBase class.

    Properties
    DoubleViewSplashScreen

    Is the splash screen displayed in VR double view.

    GraphicsCompositor
    InitialGraphicsCompositorUrl

    URL of the graphics compositor loaded at initialization.

    InitialSceneUrl

    URL of the scene loaded at initialization.

    SceneInstance

    Gets or sets the root scene.

    SplashScreenColor

    Splash screen background color.

    SplashScreenEnabled

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

    SplashScreenUrl

    URL of the splash screen texture loaded at initialization.

    Methods
    Destroy()
    Draw(GameTime)
    LoadContent()
    Update(GameTime)
    | Improve this Doc View Source

    Constructors


    SceneSystem(IServiceRegistry)

    Initializes a new instance of the GameSystemBase class.

    public SceneSystem(IServiceRegistry registry)
    Parameters
    Type Name Description
    IServiceRegistry registry

    The registry.

    Remarks

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

    | Improve this Doc View Source

    Properties


    DoubleViewSplashScreen

    Is the splash screen displayed in VR double view.

    public bool DoubleViewSplashScreen { get; set; }
    Property Value
    Type Description
    System.Boolean

    GraphicsCompositor

    public GraphicsCompositor GraphicsCompositor { get; set; }
    Property Value
    Type Description
    GraphicsCompositor

    InitialGraphicsCompositorUrl

    URL of the graphics compositor loaded at initialization.

    public string InitialGraphicsCompositorUrl { get; set; }
    Property Value
    Type Description
    System.String

    InitialSceneUrl

    URL of the scene loaded at initialization.

    public string InitialSceneUrl { get; set; }
    Property Value
    Type Description
    System.String

    SceneInstance

    Gets or sets the root scene.

    public SceneInstance SceneInstance { get; set; }
    Property Value
    Type Description
    SceneInstance

    The scene

    Exceptions
    Type Condition
    System.ArgumentNullException

    Scene cannot be null


    SplashScreenColor

    Splash screen background color.

    public Color4 SplashScreenColor { get; set; }
    Property Value
    Type Description
    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
    Type Description
    System.Boolean

    SplashScreenUrl

    URL of the splash screen texture loaded at initialization.

    public string SplashScreenUrl { get; set; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Methods


    Destroy()

    protected override void Destroy()
    Overrides
    ComponentBase.Destroy()

    Draw(GameTime)

    public override void Draw(GameTime gameTime)
    Parameters
    Type Name Description
    GameTime gameTime
    Overrides
    GameSystemBase.Draw(GameTime)

    LoadContent()

    protected override void LoadContent()
    Overrides
    GameSystemBase.LoadContent()

    Update(GameTime)

    public override void Update(GameTime gameTime)
    Parameters
    Type Name Description
    GameTime gameTime
    Overrides
    GameSystemBase.Update(GameTime)

    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.InitGraphicsDeviceService()
    GameSystemBase.EnabledChanged
    GameSystemBase.UpdateOrderChanged
    GameSystemBase.Enabled
    GameSystemBase.UpdateOrder
    GameSystemBase.OnDrawOrderChanged(Object, EventArgs)
    GameSystemBase.OnUpdateOrderChanged(Object, EventArgs)
    GameSystemBase.IContentable.LoadContent()
    GameSystemBase.IContentable.UnloadContent()
    GameSystemBase.UnloadContent()
    ComponentBase.Tags
    ComponentBase.Name
    ComponentBase.ICollectorHolder.Collector
    ComponentBase.OnNameChanged()
    ComponentBase.ToString()
    DisposeBase.Dispose()
    DisposeBase.IsDisposed
    DisposeBase.IReferencable.ReferenceCount
    DisposeBase.IReferencable.AddReference()
    DisposeBase.IReferencable.Release()
    DisposeBase.OnAddReference()
    DisposeBase.OnReleaseReference()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation