Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    BackgroundComponent Class

    Namespace: Stride.Engine
    Assembly: Stride.Engine.dll

    Add a background to an Entity.

    System.Object → EntityComponent → ActivableEntityComponent → BackgroundComponent
    Derived from BackgroundComponent:

    [DataContract("BackgroundComponent")]
    [Display("Background", null, Expand = ExpandRule.Once)]
    [DefaultEntityComponentRenderer(typeof(BackgroundRenderProcessor))]
    [ComponentOrder(9600)]
    public sealed class BackgroundComponent : ActivableEntityComponent, IIdentifiable
    Name Description
    Constructors
    BackgroundComponent()

    Create an empty Background component.

    Properties
    Intensity

    Gets or sets the intensity.

    Is2D

    Indicate if the background should behave like a 2D image.

    RenderGroup

    The render group for this component.

    Texture

    Gets or sets the texture to use as background

    | Improve this Doc View Source

    Constructors


    BackgroundComponent()

    Create an empty Background component.

    public BackgroundComponent()
    | Improve this Doc View Source

    Properties


    Intensity

    Gets or sets the intensity.

    [DataMember(20)]
    [DataMemberRange(0, 100, 0.0099999997764825821, 1, 2)]
    public float Intensity { get; set; }
    Property Value
    Type Description
    System.Single

    The intensity.


    Is2D

    Indicate if the background should behave like a 2D image.

    [DataMember(40)]
    [Display("2D background", null)]
    public bool Is2D { get; set; }
    Property Value
    Type Description
    System.Boolean

    RenderGroup

    The render group for this component.

    [DataMember(30)]
    [Display("Render group", null)]
    public RenderGroup RenderGroup { get; set; }
    Property Value
    Type Description
    RenderGroup

    Texture

    Gets or sets the texture to use as background

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

    Inherited Members

    ActivableEntityComponent.Enabled
    EntityComponent.Entity
    EntityComponent.Id
    EntityComponent.EnsureEntity

    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