Class BackgroundImage

This class render a texture to background.

Inheritance
object
IdentifiableObject
DependencyObject
AttachableObject
PrefabInstanceObject
Component
BackgroundImage
Implements
Inherited Members
Component.Owner
Component.Managers
Component.ShouldBeActivated
Component.Clone()
Component.Attach(Entity)
Component.OnLoaded()
Component.Start()
Component.OnDestroy()
PrefabInstanceObject.PrefabSource
PrefabInstanceObject.PrefabElementId
PrefabInstanceObject.IsPrefabInstance
PrefabInstanceObject.IsMissingPrefabSource
AttachableObject.AttachableStateChanged
AttachableObject.IsEnabled
AttachableObject.State
AttachableObject.IsLoaded
AttachableObject.IsAttached
AttachableObject.IsActivated
AttachableObject.IsStarted
AttachableObject.IsDestroyed
AttachableObject.Destroy()
AttachableObject.DependencyBroken()
DependencyObject.Dependencies
DependencyObject.OnDependencyRemoved
Namespace: Evergine.Components.Graphics3D
Assembly: Evergine.Components.dll
Syntax
public class BackgroundImage : Component, IDependencyObject

Properties

Layer

Gets or sets the layer used to render the background.

Declaration
public RenderLayerDescription Layer { get; set; }
Property Value
Type Description
RenderLayerDescription

OrderBias

Gets or sets the order bias.

Declaration
public int OrderBias { get; set; }
Property Value
Type Description
int

Sampler

Gets or sets the background texture.

Declaration
public SamplerState Sampler { get; set; }
Property Value
Type Description
SamplerState

Scale

Gets or sets the Stretch mode of the background texture.

Declaration
public Vector2 Scale { get; set; }
Property Value
Type Description
Vector2

SliceIndex

Gets or sets the Stretch mode of the background texture.

Declaration
public float SliceIndex { get; set; }
Property Value
Type Description
float

Stretch

Gets or sets the Stretch mode of the background texture.

Declaration
public BackgroundImage.StretchType Stretch { get; set; }
Property Value
Type Description
BackgroundImage.StretchType

TargetDisplay

Gets or sets the target display.

Declaration
public Display TargetDisplay { get; set; }
Property Value
Type Description
Display

Texture

Gets or sets the background texture.

Declaration
public Texture Texture { get; set; }
Property Value
Type Description
Texture

Methods

OnActivated()

Invoked when the object is activated once is attached.

Declaration
protected override void OnActivated()
Overrides
Evergine.Framework.Component.OnActivated()

OnAttached()

Invoked when the object is attached to the system.

Declaration
protected override bool OnAttached()
Returns
Type Description
bool

True if all is OK.
Overrides
Evergine.Framework.Component.OnAttached()

OnDeactivated()

Invoked when the object is deactivated.

Declaration
protected override void OnDeactivated()
Overrides
Evergine.Framework.Component.OnDeactivated()

OnDetach()

Invoked when the object is detached.

Declaration
protected override void OnDetach()
Overrides
Evergine.Framework.Component.OnDetach()

RefreshDimensions()

Refreshes the dimension of the background texture to render.

Declaration
protected void RefreshDimensions()

Implements

Extension Methods