Skip to content

T_Aurora_EffectsEngine_EffectLayer

Anton Pupkov edited this page Aug 8, 2016 · 2 revisions

EffectLayer Class

A class representing a bitmap layer for effects

Inheritance Hierarchy

System.Object
  Aurora.EffectsEngine.EffectLayer
Namespace: Aurora.EffectsEngine
Assembly: Aurora (in Aurora.exe) Version: 1.0.0.0 (0.0.4.6)

Syntax

C#

public class EffectLayer : IDisposable

The EffectLayer type exposes the following members.

Constructors

 

Name Description
Public method EffectLayer() Creates a new instance of the EffectLayer class with default parameters.
Public method EffectLayer(String) Creates a new instance of the EffectLayer class with a specified layer name.
Public method EffectLayer(EffectLayer) A copy constructor, Creates a new instance of the EffectLayer class from another EffectLayer instance.
Public method EffectLayer(String, Color) Creates a new instance of the EffectLayer class with a specified layer name. And fills the layer bitmap with a specified color.
Public method EffectLayer(String, LayerEffects, LayerEffectConfig, RectangleF) Creates a new instance of the EffectLayer class with a specified layer name. And applies a LayerEffect onto this EffectLayer instance. Using the parameters from LayerEffectConfig and a specified region in RectangleF
  Back to Top

Methods

 

Name Description
Public method AddPostFunction Adds a post function to the EffectLayer, to be executed at render time.
Public method Dispose
Public method DrawColorZones Draws ColorZones on the layer bitmap.
Public method DrawFreeForm Draws a FreeFormObject on the layer bitmap using a specified color.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Fill(Brush) Fills the entire bitmap of the EffectLayer with a specified brush.
Public method Fill(Color) Fills the entire bitmap of the EffectLayer with a specified color.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Get(DeviceKeys) Retrieves a color of the specified DeviceKeys key from the bitmap
Public method Get(Int32, Int32) Retrieves a color of the specified X and Y coordinate on the bitmap
Public method GetBitmap Get the current layer bitmap.
Public method GetGraphics Get an instance of Drawing.Graphics, to allow drawing on the bitmap.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method PercentEffect(ColorSpectrum, DeviceKeys[], Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using DeviceKeys keys and a ColorSpectrum.
Public method PercentEffect(ColorSpectrum, FreeFormObject, Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using a FreeFormObject and a ColorSpectrum.
Public method PercentEffect(ColorSpectrum, KeySequence, Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using a KeySequence and a ColorSpectrum.
Public method PercentEffect(Color, Color, DeviceKeys[], Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using an array of DeviceKeys keys and solid colors.
Public method PercentEffect(Color, Color, FreeFormObject, Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using a FreeFormObject and solid colors.
Public method PercentEffect(Color, Color, KeySequence, Double, Double, PercentEffectType) Draws a percent effect on the layer bitmap using a KeySequence with solid colors.
Public method RenderLayer Renders the post functions onto the layer bitmap.
Public method Set(DeviceKeys, Color) Sets a specific Devices.DeviceKeys on the bitmap with a specified color.
Public method Set(KeySequence, Color) Sets a specific KeySequence on the bitmap with a specified color.
Public method Set(Int32, Int32, Color) Sets a specific coordinate on the bitmap with a specified color.
Public method ToString Returns the layer name (Overrides Object.ToString().)
  Back to Top

Operators

 

Name Description
Public operatorStatic member Addition
  • Operator, sums two EffectLayer together.
Public operatorStatic member Multiply
  • Operator, Multiplies an EffectLayer by a double, adjusting opacity and color of the layer bitmap.
  Back to Top

See Also

Reference

Aurora.EffectsEngine Namespace

Clone this wiki locally