Interface IBrush

Represents a basic brush.

Inherited Members

IDecoratable<IBrushDecorator>.Decorators

IDecoratable<IBrushDecorator>.AddDecorator(IBrushDecorator)

IDecoratable<IBrushDecorator>.RemoveDecorator(IBrushDecorator)

IDecoratable<IBrushDecorator>.RemoveAllDecorators()

INotifyPropertyChanged.PropertyChanged

Namespace: RGB.NET.Core

Assembly: RGB.NET.Core.dll

Syntax

public interface IBrush : IDecoratable<IBrushDecorator>, IDecoratable, INotifyPropertyChanged

Properties

Brightness

Gets or sets the overall percentage brightness of the IBrush.

Declaration

float Brightness { get; set; }

Property Value

Type	Description
float

CalculationMode

Gets or sets the calculation mode used for the rectangle/points used for color-selection in brushes.

Declaration

RenderMode CalculationMode { get; set; }

Property Value

Type	Description
RenderMode

IsEnabled

Gets or sets if the IBrush is enabled and will be drawn on an update.

Declaration

bool IsEnabled { get; set; }

Property Value

Type	Description
bool

Opacity

Gets or sets the overall percentage opacity of the IBrush.

Declaration

float Opacity { get; set; }

Property Value

Type	Description
float

Methods

Render(Rectangle, IEnumerable<RenderTarget>)

Performs the render pass of the IBrush and calculates the raw Color for all requested RenderTarget.

Declaration

IEnumerable<(RenderTarget renderTarget, Color color)> Render(Rectangle rectangle, IEnumerable<RenderTarget> renderTargets)

Parameters

Type	Name	Description
Rectangle	rectangle	The Rectangle in which the brush should be drawn.
IEnumerable<RenderTarget>	renderTargets	The RenderTarget (keys/points) of which the color should be calculated.

Returns

Type	Description
IEnumerable<(RenderTarget renderTarget, Color color)>