Empeld
Empeld plugin documentation.
pluginbase.Objects.World.Environment.IFilter Interface Reference

The post-process filter definition interface More...

Inheritance diagram for pluginbase.Objects.World.Environment.IFilter:
pluginbase.Objects.World.Environment.IEnvironmentSimulatable pluginbase.Objects.World.Environment.Filter.FilterBase essentials.Environment.Filters.ColorFilter essentials.Environment.Filters.VignetteFilter

Properties

bool Active [get]
 Gets a value indicating whether this pluginbase.Objects.World.Environment.IFilter is active. More...
 
Rgba FilterColor [get]
 Gets the color of the filter. More...
 
FilterMode FilterMode [get]
 The mode in which the color-layer is filtered More...
 
string Texture [get]
 The texture file, if any (can be null) More...
 
Rgba TextureColor [get]
 The color to apply to the texture layer More...
 
FilterMode TextureMode [get]
 The filter mode to apply to the texture layer More...
 

Additional Inherited Members

- Public Member Functions inherited from pluginbase.Objects.World.Environment.IEnvironmentSimulatable
void Simulate (double time, double x, double y, double z)
 Simulate the environment with the time, and an x/y/z More...
 

Detailed Description

The post-process filter definition interface

Property Documentation

◆ Active

bool pluginbase.Objects.World.Environment.IFilter.Active
get

Gets a value indicating whether this pluginbase.Objects.World.Environment.IFilter is active.

true if active; otherwise, false.

◆ FilterColor

Rgba pluginbase.Objects.World.Environment.IFilter.FilterColor
get

Gets the color of the filter.

The color of the filter.

◆ FilterMode

FilterMode pluginbase.Objects.World.Environment.IFilter.FilterMode
get

The mode in which the color-layer is filtered

The filter mode.

◆ Texture

string pluginbase.Objects.World.Environment.IFilter.Texture
get

The texture file, if any (can be null)

The texture.

◆ TextureColor

Rgba pluginbase.Objects.World.Environment.IFilter.TextureColor
get

The color to apply to the texture layer

The color of the texture.

◆ TextureMode

FilterMode pluginbase.Objects.World.Environment.IFilter.TextureMode
get

The filter mode to apply to the texture layer

The texture mode.


The documentation for this interface was generated from the following file: