Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    StreamingSettings Class

    Namespace: Stride.Streaming
    Assembly: Stride.Rendering.dll
    System.Object → Configuration → StreamingSettings
    Derived from StreamingSettings:

    [DataContract]
    [Display("Streaming", null)]
    public sealed class StreamingSettings : Configuration
    Name Description
    Properties
    Enabled

    Gets or sets a value indicating whether resource streaming should be disabled.

    ManagerUpdatesInterval

    The interval between StreamingManager updates.

    MaxResourcesPerUpdate

    The maximum number of resources updated per streaming manager tick. Used to balance performance/streaming speed.

    ResourceLiveTimeout

    The StreamableResource live timeout. Resources that aren't used for a while are downscaled in quality.

    TargetedMemoryBudget

    The targeted memory budget of the streaming system in MB. If the memory allocated by streaming system is under this budget it will not try to unload not visible resources.

    | Improve this Doc View Source

    Properties


    Enabled

    Gets or sets a value indicating whether resource streaming should be disabled.

    [DataMember]
    public bool Enabled { get; set; }
    Property Value
    Type Description
    System.Boolean
    See Also
    Enabled

    ManagerUpdatesInterval

    The interval between StreamingManager updates.

    [DataMember]
    [Display("Update interval", null)]
    [DataMemberRange(0.001, 3)]
    public TimeSpan ManagerUpdatesInterval { get; set; }
    Property Value
    Type Description
    System.TimeSpan
    See Also
    ManagerUpdatesInterval

    MaxResourcesPerUpdate

    The maximum number of resources updated per streaming manager tick. Used to balance performance/streaming speed.

    [DataMember]
    [Display("Max resources per update", null)]
    [DataMemberRange(1, 0)]
    public int MaxResourcesPerUpdate { get; set; }
    Property Value
    Type Description
    System.Int32
    See Also
    MaxResourcesPerUpdate

    ResourceLiveTimeout

    The StreamableResource live timeout. Resources that aren't used for a while are downscaled in quality.

    [DataMember]
    [Display("Resource timeout (ms)", null)]
    [DataMemberRange(0, 3)]
    public TimeSpan ResourceLiveTimeout { get; set; }
    Property Value
    Type Description
    System.TimeSpan
    See Also
    ResourceLiveTimeout

    TargetedMemoryBudget

    The targeted memory budget of the streaming system in MB. If the memory allocated by streaming system is under this budget it will not try to unload not visible resources.

    [DataMember]
    [Display("Memory budget (in MB)", null)]
    [DataMemberRange(0, 0)]
    public int TargetedMemoryBudget { get; set; }
    Property Value
    Type Description
    System.Int32
    See Also
    TargetedMemoryBudget

    Inherited Members

    Configuration.OfflineOnly

    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