ImageDecal

Description

sealed class Tinman.Engine.Scenes.Entities.ImageDecal

Derived from: SceneEntityBase ^abstract
ILightingProperty
IRenderPriority

A scene entity that puts a geo-referenced image as a decal onto the terrain.

The default value for the ILightingProperty.Lighting property is false.

See also: TerrainDecal

Public / Constructors

ImageDecal

public constructor ImageDecal → ()

Creates a new instance of ImageDecal.

Public / Attributes

Color

public attribute Color → (get,set)

value : int64: The modulation color.

The color to use for modulating the decal texture.

Defaults to Colors.White.

Content

public attribute Content → (get,set)

value : IImage: The image content.

The geo-referenced image content of the terrain decal.

Format

public attribute Format → (get,set)

value : PixelFormat: The pixel format.

The pixel format to use when choosing the underlying texture format.

For rendering, the image decal must be present on the GPU as a texture. The texture format (see TextureFormat) is chosen automatically, based on the pixel format of the image data (TextureFormat.For).

When this property is set to PixelFormat.Unknown, the pixel format of the given content image will be used (see IImageInfo.PixelFormat). Otherwise, the specified pixel format is used.

Defaults to PixelFormat.Unknown.

SortIndex

public attribute SortIndex → (get,set)

value : int32: The sort index, see TerrainDecal.SortIndex.

The terrain layer sort index of this texture decal.

Logging

Logger

public static readonly attribute Logger → (ILogger)

The logger object of this class.