BackgroundRenderProcessor Class

    Namespace: Stride.Rendering.Background
    Assembly: Stride.Engine.dll

    A default entity processor for BackgroundComponent.

    System.Object → EntityProcessor → EntityProcessor<BackgroundComponent, RenderBackground> → BackgroundRenderProcessor
    Derived from BackgroundRenderProcessor: 

    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.
    | Improve this Doc View Source

    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
    | Improve this Doc View Source

    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
    Stride.Engine.EntityProcessor<Stride.Engine.BackgroundComponent, Stride.Rendering.Background.RenderBackground>.GenerateComponentData(Stride.Engine.Entity, Stride.Engine.BackgroundComponent)

    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
    Stride.Engine.EntityProcessor<Stride.Engine.BackgroundComponent, Stride.Rendering.Background.RenderBackground>.IsAssociatedDataValid(Stride.Engine.Entity, Stride.Engine.BackgroundComponent, Stride.Rendering.Background.RenderBackground)

    OnSystemRemove()

    Run when this EntityProcessor is removed from an EntityManager.

    protected override void OnSystemRemove()
    Overrides
    Stride.Engine.EntityProcessor<Stride.Engine.BackgroundComponent, Stride.Rendering.Background.RenderBackground>.OnSystemRemove()

    Inherited Members

    Extension Methods