Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ForceAspectRatioSceneRenderer Class

    Namespace: Stride.Rendering.Compositing
    Assembly: Stride.Rendering.dll
    System.Object → DisposeBase → ComponentBase → RendererCoreBase → SceneRendererBase → ForceAspectRatioSceneRenderer
    Derived from ForceAspectRatioSceneRenderer:

    public class ForceAspectRatioSceneRenderer : SceneRendererBase, IComponent, IReferencable, ICollectorHolder, ISceneRenderer, IRenderCollector, IGraphicsRenderer, IGraphicsRendererBase, IGraphicsRendererCore, IDisposable
    Name Description
    Fields
    DefaultAspectRatio
    Properties
    Child
    FixedAspectRatio

    Gets or sets the aspect ratio.

    ForceAspectRatio

    Gets or sets a value wether to edit the Viewport to force the aspect ratio and add letterboxes or pillarboxes where needed

    Methods
    CollectCore(RenderContext)

    Main collect method.

    DrawCore(RenderContext, RenderDrawContext)

    Main drawing method for this renderer that must be implemented.

    | Improve this Doc View Source

    Fields


    DefaultAspectRatio

    public const float DefaultAspectRatio = 1.77777779F
    Field Value
    Type Description
    System.Single
    | Improve this Doc View Source

    Properties


    Child

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

    FixedAspectRatio

    Gets or sets the aspect ratio.

    public float FixedAspectRatio { get; set; }
    Property Value
    Type Description
    System.Single

    The aspect ratio.


    ForceAspectRatio

    Gets or sets a value wether to edit the Viewport to force the aspect ratio and add letterboxes or pillarboxes where needed

    public bool ForceAspectRatio { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Methods


    CollectCore(RenderContext)

    Main collect method.

    protected override void CollectCore(RenderContext context)
    Parameters
    Type Name Description
    RenderContext context
    Overrides
    SceneRendererBase.CollectCore(RenderContext)

    DrawCore(RenderContext, RenderDrawContext)

    Main drawing method for this renderer that must be implemented.

    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)
    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