Class BackgroundRenderProcessor
- Namespace
- Stride.Rendering.Background
- Assembly
- Stride.Engine.dll
A default entity processor for BackgroundComponent.
public class BackgroundRenderProcessor : EntityProcessor<BackgroundComponent, RenderBackground>, IEntityComponentRenderProcessor- Inheritance
-
BackgroundRenderProcessor
- Implements
- Inherited Members
Properties
ActiveBackground
Gets the active background.
public RenderBackground ActiveBackground { get; }Property Value
- RenderBackground
The active background.
VisibilityGroup
public VisibilityGroup VisibilityGroup { get; set; }Property Value
Methods
Draw(RenderContext)
Performs work related to this processor.
public override void Draw(RenderContext context)Parameters
contextRenderContext
GenerateComponentData(Entity, BackgroundComponent)
Generates associated data to the given entity.
protected override RenderBackground GenerateComponentData(Entity entity, BackgroundComponent component)Parameters
entityEntityThe entity.
componentBackgroundComponent
Returns
- RenderBackground
The associated data.
IsAssociatedDataValid(Entity, BackgroundComponent, RenderBackground)
Checks if the current associated data is valid, or if readding the entity is required.
protected override bool IsAssociatedDataValid(Entity entity, BackgroundComponent component, RenderBackground associatedData)Parameters
entityEntityThe entity.
componentBackgroundComponentassociatedDataRenderBackgroundThe associated data.
Returns
- bool
True if the change in associated data requires the entity to be readded, false otherwise.
OnSystemRemove()
Run when this EntityProcessor is removed from an EntityManager.
protected override void OnSystemRemove()