BackgroundRenderProcessor Class
Namespace: Stride.Rendering.BackgroundAssembly: Stride.Engine.dll
A default entity processor for BackgroundComponent.
public class BackgroundRenderProcessor : EntityProcessor<BackgroundComponent, RenderBackground>, IEntityComponentRenderProcessor
Name | Description | |
---|---|---|
Properties | ||
ActiveBackground | Gets the active background. |
|
VisibilityGroup | ||
Methods | ||
Draw(RenderContext) | Performs work related to this processor. |
|
GenerateComponentData(Entity, BackgroundComponent) | Generates associated data to the given entity. |
|
IsAssociatedDataValid(Entity, BackgroundComponent, RenderBackground) | Checks if the current associated data is valid, or if readding the entity is required. |
|
OnSystemRemove() | Run when this EntityProcessor is removed from an EntityManager. |
Properties
ActiveBackground
Gets the active background.
public RenderBackground ActiveBackground { get; }
Property Value
Type | Description |
---|---|
RenderBackground | The active background. |
VisibilityGroup
public VisibilityGroup VisibilityGroup { get; set; }
Property Value
Type | Description |
---|---|
VisibilityGroup |
Methods
Draw(RenderContext)
Performs work related to this processor.
public override void Draw(RenderContext context)
Parameters
Type | Name | Description |
---|---|---|
RenderContext | context |
Overrides
GenerateComponentData(Entity, BackgroundComponent)
Generates associated data to the given entity.
protected override RenderBackground GenerateComponentData(Entity entity, BackgroundComponent component)
Parameters
Type | Name | Description |
---|---|---|
Entity | entity | The entity. |
BackgroundComponent | component |
Returns
Type | Description |
---|---|
RenderBackground | The associated data. |
Overrides
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
Type | Name | Description |
---|---|---|
Entity | entity | The entity. |
BackgroundComponent | component | |
RenderBackground | associatedData |
Returns
Type | Description |
---|---|
System.Boolean | True if the change in associated data requires the entity to be readded, false otherwise. |
Overrides
OnSystemRemove()
Run when this EntityProcessor is removed from an EntityManager.
protected override void OnSystemRemove()