Home | API by Category | Complete API Index | API Status

Applies a color tint to its entire scene canvas.

public class Electron2D.CanvasModulate

One visible node controls each canvas. Other visible modulators wait until the selected node hides or leaves. Independent CanvasLayer and World canvases retain independent colors. This node contributes no geometry; its transform does not limit the tinted area.

Inherits: Entity

Detailed engine reference

Kind: constructor

public CanvasModulate()

Creates a visible detached modulator with opaque white color.

Kind: method

protected override System.Func<Electron2D.Node> CreateSceneInstanceFactory()

Kind: method

public override System.String[] GetConfigurationWarnings()

Reports multiple visible modulators on the same canvas; only one controls its color.

Kind: method

protected override System.Collections.Generic.IEnumerable<Electron2D.PropertyDescriptor> GetPropertyDescriptors()

Kind: method

protected override System.Void OnNotification(System.Int32 what)

Kind: property

public Electron2D.Color Color { get; set; }

Gets or sets the tint applied when this node is selected on its canvas.

Each assignment commits, including equal values. Hidden or waiting nodes retain their authored color without changing the selected canvas. No redraw of sibling commands is required.

Opaque white initially; all finite color components are accepted.

• T:System.ArgumentException: A color component is nonfinite.
• T:System.InvalidOperationException: An attached access is off-owner or mutation occurs during scene capture.
• T:System.ObjectDisposedException: This node is disposed.