Class SceneRendererRegistration

Namespace

Stride.CommunityToolkit.Rendering.Compositing

Assembly

Stride.CommunityToolkit.dll

How a component's processor makes sure the scene renderer that draws it is on the compositor, where nothing else put it there: Game Studio's scene editor, which runs processors but never a game's setup code, or a game that skipped the Add*Renderer call.

public static class SceneRendererRegistration

Inheritance

object

SceneRendererRegistration

Remarks

The compositor is the one of the scene system that owns the processor's scene, not whatever the render context carries - in the editor that is the gizmo compositor's. It is checked every frame because the editor swaps compositors: at start, from its fallback to the project's, and on every change of the view mode. A renderer on the old one draws in nothing.

Methods

Ensure<TRenderer>(IServiceRegistry, EntityManager, ref GraphicsCompositor?, Func<TRenderer>)

Puts a TRenderer on the owning scene system's compositor unless one is there already, remembering the compositor so the check is one reference comparison per frame.

public static void Ensure<TRenderer>(IServiceRegistry services, EntityManager entityManager, ref GraphicsCompositor? ensuredOn, Func<TRenderer> create) where TRenderer : SceneRendererBase

Parameters

services IServiceRegistry

The processor's services.

entityManager EntityManager

The processor's entity manager, which must be the scene system's scene instance for anything to happen.

ensuredOn GraphicsCompositor

The compositor the renderer was last ensured on; updated here.

create Func<TRenderer>

Makes the renderer when the compositor has none.

Type Parameters

TRenderer

OwningCompositor(IServiceRegistry, EntityManager)

The compositor that draws the scene entityManager belongs to: the one on the scene system whose scene instance it is. Null for any other entity manager, and until the scene system has a compositor. What a processor registers its renderer, feature or render object with - not the render context's render system, which is whichever compositor drew last and in Game Studio is the gizmo compositor's.

public static GraphicsCompositor? OwningCompositor(IServiceRegistry services, EntityManager entityManager)

Parameters

services IServiceRegistry

entityManager EntityManager

Returns

GraphicsCompositor