GraphicsCompositor Class

    Namespace: Stride.Rendering.Compositing
    Assembly: Stride.Engine.dll
    System.Object → DisposeBase → ComponentBase → RendererCoreBase → RendererBase → GraphicsCompositor
    Derived from GraphicsCompositor: 

    [DataSerializerGlobal(typeof(ReferenceSerializer<GraphicsCompositor>), null, DataSerializerGenericMode.None, false, false, Profile = "Content")]
[ContentSerializer(typeof(DataContentSerializerWithReuse<GraphicsCompositor>))]
[DataContract]
[DataSerializerGlobal(null, typeof(FastTrackingCollection<RenderStage>), DataSerializerGenericMode.None, false, false)]
[DataSerializerGlobal(null, typeof(FastTrackingCollection<RootRenderFeature>), DataSerializerGenericMode.None, false, false)]
public class GraphicsCompositor : RendererBase, IComponent, IReferencable, ICollectorHolder, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Fields
    Current

    A property key to get the current graphics compositor from the .
    Properties
    Cameras

    Gets the cameras used by this composition.
    Editor

    The entry point for a compositor used by the scene editor.
    Game

    The entry point for the game compositor.
    RenderFeatures

    The list of render features.
    RenderStages

    The list of render stages.
    RenderSystem

    Gets the render system used with this graphics compositor.
    SingleView

    The entry point for a compositor that can render a single view.
    Methods
    Destroy()
    DrawCore(RenderDrawContext)

    Main drawing method for this renderer that must be implemented.

    InitializeCore()
    | Improve this Doc View Source

    Fields

    Current

    A property key to get the current graphics compositor from the .

    public static readonly PropertyKey<GraphicsCompositor> Current
    Field Value
    Type Description
    PropertyKey<GraphicsCompositor>
    | Improve this Doc View Source

    Properties

    Cameras

    Gets the cameras used by this composition.

    [DataMember(10)]
public SceneCameraSlotCollection Cameras { get; }
    Property Value
    Type Description
    SceneCameraSlotCollection

    The cameras.

    Editor

    The entry point for a compositor used by the scene editor.

    public ISceneRenderer Editor { get; set; }
    Property Value
    Type Description
    ISceneRenderer

    Game

    The entry point for the game compositor.

    public ISceneRenderer Game { get; set; }
    Property Value
    Type Description
    ISceneRenderer

    RenderFeatures

    The list of render features.

    [DataMember(30)]
public IList<RootRenderFeature> RenderFeatures { get; }
    Property Value
    Type Description
    System.Collections.Generic.IList<RootRenderFeature>

    RenderStages

    The list of render stages.

    [DataMember(20)]
public IList<RenderStage> RenderStages { get; }
    Property Value
    Type Description
    System.Collections.Generic.IList<RenderStage>

    RenderSystem

    Gets the render system used with this graphics compositor.

    public RenderSystem RenderSystem { get; }
    Property Value
    Type Description
    RenderSystem

    SingleView

    The entry point for a compositor that can render a single view.

    public ISceneRenderer SingleView { get; set; }
    Property Value
    Type Description
    ISceneRenderer
    | Improve this Doc View Source

    Methods

    Destroy()

    protected override void Destroy()
    Overrides

    DrawCore(RenderDrawContext)

    Main drawing method for this renderer that must be implemented. 

    protected override void DrawCore(RenderDrawContext context)
    Parameters
    Type Name Description
    RenderDrawContext context

    The context.
    Overrides

    InitializeCore()

    protected override void InitializeCore()
    Overrides

    Inherited Members

    Extension Methods