Class BackgroundComponent

Namespace

Stride.Engine

Assembly

Stride.Engine.dll

Add a background to an Entity.

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

Inheritance

object

EntityComponent

ActivableEntityComponent

BackgroundComponent

Implements

IIdentifiable

Inherited Members

ActivableEntityComponent.Enabled

EntityComponent.Entity

EntityComponent.Id

Constructors

BackgroundComponent()

Create an empty Background component.

public BackgroundComponent()

Properties

Intensity

Gets or sets the intensity.

[DataMember(20)]
[DataMemberRange(0, 100, 0.009999999776482582, 1, 2)]
public float Intensity { get; set; }

Property Value

float

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

bool

RenderGroup

The render group for this component.

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

Property Value

RenderGroup

Texture

Gets or sets the texture to use as background

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

Property Value

Texture