Class EditorTopLevelCompositor

Namespace

Stride.Rendering.Compositing

Assembly

Stride.Engine.dll

Used by editor as top level compositor.

public class EditorTopLevelCompositor : SceneExternalCameraRenderer, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererCore, IDisposable, ISharedRenderer, IIdentifiable, IGraphicsRendererBase

Inheritance

object

DisposeBase

ComponentBase

RendererCoreBase

SceneRendererBase

SceneCameraRenderer

SceneExternalCameraRenderer

EditorTopLevelCompositor

Implements

IComponent

IReferencable

ICollectorHolder

ISceneRenderer

IRenderCollector

IGraphicsRenderer

IGraphicsRendererCore

IDisposable

ISharedRenderer

IIdentifiable

IGraphicsRendererBase

Inherited Members

SceneExternalCameraRenderer.ExternalCamera

SceneExternalCameraRenderer.ResolveCamera(RenderContext)

SceneCameraRenderer.RenderView

SceneCameraRenderer.Camera

SceneCameraRenderer.Child

SceneCameraRenderer.RenderMask

SceneCameraRenderer.Logger

SceneCameraRenderer.CollectCore(RenderContext)

SceneCameraRenderer.DrawCore(RenderContext, RenderDrawContext)

SceneCameraRenderer.UpdateCameraToRenderView(RenderContext, RenderView, CameraComponent)

SceneRendererBase.Id

SceneRendererBase.Collect(RenderContext)

SceneRendererBase.Draw(RenderDrawContext)

RendererCoreBase.Enabled

RendererCoreBase.Profiling

RendererCoreBase.GPUProfilingKey

RendererCoreBase.CPUProfilingKey

RendererCoreBase.Context

RendererCoreBase.Services

RendererCoreBase.Content

RendererCoreBase.GraphicsDevice

RendererCoreBase.EffectSystem

RendererCoreBase.Initialized

RendererCoreBase.Initialize(RenderContext)

RendererCoreBase.InitializeCore()

RendererCoreBase.Unload()

RendererCoreBase.PreDrawCore(RenderDrawContext)

RendererCoreBase.PostDrawCore(RenderDrawContext)

RendererCoreBase.NewScopedBuffer(BufferDescription, PixelFormat)

RendererCoreBase.NewScopedTypedBuffer(int, PixelFormat, bool, GraphicsResourceUsage)

RendererCoreBase.PushScopedResource<T>(T)

RendererCoreBase.CheckIsInDrawCore()

RendererCoreBase.Destroy()

RendererCoreBase.ToLoadAndUnload<T>(T)

RendererCoreBase.PreDrawCoreInternal(RenderDrawContext)

RendererCoreBase.EnsureContext(RenderContext)

RendererCoreBase.PostDrawCoreInternal(RenderDrawContext)

ComponentBase.Tags

ComponentBase.Name

ComponentBase.OnNameChanged()

ComponentBase.ToString()

DisposeBase.IsDisposed

DisposeBase.Dispose()

DisposeBase.OnAddReference()

DisposeBase.OnReleaseReference()

Extension Methods

ComponentBaseExtensions.PushTagAndRestore<T>(ComponentBase, PropertyKey<T?>, T)

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.KeepReference<T>(T)

ComponentBaseExtensions.ReleaseBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveReleaseBy<T>(T, ICollectorHolder)

UnsafeUtilities.As<T>(object?)

Fields

TopmostOverlayGizmoLayer

The layer of the overlay gizmo drawn over every other one (the transform gizmo).

public const int TopmostOverlayGizmoLayer = 100

Field Value

int

Properties

EnablePreviewGame

When true, PreviewGame will be used as compositor.

public bool EnablePreviewGame { get; set; }

Property Value

bool

PostGizmoCompositors

Renderers drawn after the scene, depth-tested against it (grid, wireframes, pickers).

public List<ISceneRenderer> PostGizmoCompositors { get; }

Property Value

List<ISceneRenderer>

PreGizmoCompositors

public List<ISceneRenderer> PreGizmoCompositors { get; }

Property Value

List<ISceneRenderer>

PreviewGame

Compositor for previewing game, used when EnablePreviewGame is true.

public ISceneRenderer PreviewGame { get; set; }

Property Value

ISceneRenderer

Methods

AddOverlayGizmoCompositor(ISceneRenderer, int)

Adds a renderer drawn after PostGizmoCompositors over a cleared depth buffer, so it shows through the scene.

public void AddOverlayGizmoCompositor(ISceneRenderer renderer, int layer = 0)

Parameters

renderer ISceneRenderer

Group stages that share one depth clear in a SceneRendererCollection.

layer int

Overlays draw by increasing layer, TopmostOverlayGizmoLayer last.

CollectInner(RenderContext)

protected override void CollectInner(RenderContext context)

Parameters

context RenderContext

DrawInner(RenderDrawContext)

protected override void DrawInner(RenderDrawContext context)

Parameters

context RenderDrawContext

RemoveOverlayGizmoCompositor(ISceneRenderer)

public bool RemoveOverlayGizmoCompositor(ISceneRenderer renderer)

Parameters

renderer ISceneRenderer

Returns

bool