Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ClearRenderer Class

    Namespace: Stride.Rendering.Compositing
    Assembly: Stride.Rendering.dll

    A renderer to clear a render frame.

    System.Object → DisposeBase → ComponentBase → RendererCoreBase → SceneRendererBase → ClearRenderer
    Derived from ClearRenderer:

    [Display("Clear", null)]
    public class ClearRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Constructors
    ClearRenderer()

    Initializes a new instance of the ClearRenderer class.

    Properties
    ClearFlags

    Gets or sets the clear flags.

    Color

    Gets or sets the clear color.

    Depth

    Gets or sets the depth value used to clear the depth stencil buffer.

    Stencil

    Gets or sets the stencil value used to clear the depth stencil buffer.

    Methods
    DrawCore(RenderContext, RenderDrawContext)
    | Improve this Doc View Source

    Constructors


    ClearRenderer()

    Initializes a new instance of the ClearRenderer class.

    public ClearRenderer()
    | Improve this Doc View Source

    Properties


    ClearFlags

    Gets or sets the clear flags.

    [DataMember(10)]
    [Display("Clear Flags", null)]
    public ClearRendererFlags ClearFlags { get; set; }
    Property Value
    Type Description
    ClearRendererFlags

    The clear flags.


    Color

    Gets or sets the clear color.

    [DataMember(20)]
    [Display("Color", null)]
    public Color4 Color { get; set; }
    Property Value
    Type Description
    Color4

    The clear color.


    Depth

    Gets or sets the depth value used to clear the depth stencil buffer.

    [DataMember(30)]
    [Display("Depth Value", null)]
    public float Depth { get; set; }
    Property Value
    Type Description
    System.Single

    The depth value used to clear the depth stencil buffer.


    Stencil

    Gets or sets the stencil value used to clear the depth stencil buffer.

    [DataMember(40)]
    [Display("Stencil Value", null)]
    public byte Stencil { get; set; }
    Property Value
    Type Description
    System.Byte

    The stencil value used to clear the depth stencil buffer.

    | Improve this Doc View Source

    Methods


    DrawCore(RenderContext, RenderDrawContext)

    protected override void DrawCore(RenderContext context, RenderDrawContext drawContext)
    Parameters
    Type Name Description
    RenderContext context
    RenderDrawContext drawContext
    Overrides
    SceneRendererBase.DrawCore(RenderContext, RenderDrawContext)

    Inherited Members

    SceneRendererBase.Id
    SceneRendererBase.Collect(RenderContext)
    SceneRendererBase.Draw(RenderDrawContext)
    SceneRendererBase.CollectCore(RenderContext)
    RendererCoreBase.Enabled
    RendererCoreBase.Profiling
    RendererCoreBase.ProfilingKey
    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(Int32, PixelFormat, Boolean, 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.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