s&box docs
API ReferenceSandbox.UI

public class Sandbox.UI.ScenePanel : Sandbox.UI.Panel

Allows to render a scene world onto a panel.

Constructors

Showing 2 constructors

Methods

Showing 5 methods

public virtual void Delete(bool immediate = False)

Parameters

  • immediate: Default: False

public virtual void OnDraw()

public void RenderNextFrame()

Render the panel again next frame. This is meant to be used with RenderOnce, where you might want to render on demand or only once.

public virtual void SetProperty(string name, string value)

public virtual void Tick()

Properties

Showing 5 properties

public Sandbox.SceneCamera Sandbox.UI.ScenePanel.Camera { get; set; }Obsolete

The camera we're going to be using to render

Obsolete: Handling SceneObjects like this manually will be removed soon. Use the actual Scene.

public bool Sandbox.UI.ScenePanel.RenderOnce { get; set; }

If enabled, the scene will only render once. That isn't totally accurate though, because we'll also re-render the scene when the size of the panel changes.

public Sandbox.Scene Sandbox.UI.ScenePanel.RenderScene { get; set; }

The Scene this panel renders.

public Sandbox.Texture Sandbox.UI.ScenePanel.RenderTexture { get; set; }

The texture that the panel is rendering to internally. This will change to a different texture if the panel changes size, so I wouldn't hold onto this object.

public Sandbox.SceneWorld Sandbox.UI.ScenePanel.World { get; set; }Obsolete

Shortcut to Camera.World

Obsolete: Handling SceneObjects like this manually will be removed soon. Use the actual Scene.

Metadata

FieldValue
NamespaceSandbox.UI
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.UI.ScenePanel

On this page