The RGBAMatrixBitmapEffect displays a defined part of a bitmap in the given colors on a area of a RGBAtoy Matrix. The effect take the overall brightness of the pixels of the bitmap to control the brightness of the specified colors for each pixel. More...

Inheritance diagram for DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleBitmapEffect:

Public Member Functions
override RGBAColor	GetEffectValue (int TriggerValue, PixelData Pixel)
	Gets the value for a single element in the matrix. More...

override void	Init (Table.Table Table)

Public Member Functions inherited from DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< RGBAColor >
abstract MatrixElementType	GetEffectValue (int TriggerValue, PixelData Pixel)
	Gets the value which is to be applied to all elements of the matrix area controlled by the effect. This methed must be overwritten. More...

override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given data. More...

override void	Init (Table.Table Table)
	Initializes the effect. Resolves object references, extracts source image data. More...

override void	Finish ()
	Finishes the effect and releases object references More...

Properties
RGBAColor	ActiveColor `[get, set]`
	Gets or sets the active color. The FadeMode property defines how this value is used. More...

RGBAColor	InactiveColor `[get, set]`
	Gets or sets the inactive color. The FadeMode property defines how this value is used. More...

Properties inherited from DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< RGBAColor >
int	BitmapFrameNumber `[get, set]`
	Gets or sets the number of the frame to be used. This is usefull if you work with animated gifs. More...

int	BitmapTop `[get, set]`
	Gets or sets the top of the the part of the bitmap which is to be used. More...

int	BitmapLeft `[get, set]`
	Gets or sets the left boundary of the the part of the bitmap which is to be used. More...

int	BitmapWidth `[get, set]`
	Gets or sets the width of the the part of the bitmap which is to be used. More...

int	BitmapHeight `[get, set]`
	Gets or sets the height of the the part of the bitmap which is to be used. More...

FastBitmapDataExtractModeEnum	DataExtractMode `[get, set]`
	Gets or sets the mode how data is extracted from the source bitmap. More...

FilePattern	BitmapFilePattern `[get, set]`
	Gets or sets the file pattern which is used to load the bitmap file for the effect. More...

Additional Inherited Members
Protected Attributes inherited from DirectOutput.FX.MatrixFX.MatrixBitmapEffectBase< RGBAColor >
PixelData[,]	Pixels

Detailed Description

The RGBAMatrixBitmapEffect displays a defined part of a bitmap in the given colors on a area of a RGBAtoy Matrix. The effect take the overall brightness of the pixels of the bitmap to control the brightness of the specified colors for each pixel.

The properties of the effect allow you to select the part of the bitmap to display as well as the area of the matrix on which the bitmap is displayed. Depending on the size of your bitmap you might choose different modes for the image extraction.

The effect supports numerous image formats, inluding png, gif (also animated) and jpg.

The image extraction takes place upon initalization of the framework. While the framework is active, it only outputs the previously extracted and scaled data to allow for better performance.

Definition at line 16 of file RGBAMatrixColorScaleBitmapEffect.cs.

Member Function Documentation

override RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleBitmapEffect.GetEffectValue	(	int	TriggerValue,
		PixelData	Pixel
	)

Gets the value for a single element in the matrix.

Parameters

TriggerValue	The trigger value.
Pixel	A pixel representing a element in the matrix.

Returns: The RGBAData for a element in the matrix

Definition at line 57 of file RGBAMatrixColorScaleBitmapEffect.cs.

override void DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleBitmapEffect.Init ( Table.Table Table )

Definition at line 69 of file RGBAMatrixColorScaleBitmapEffect.cs.

Property Documentation

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleBitmapEffect.ActiveColor

getset

Gets or sets the active color. The FadeMode property defines how this value is used.

The active color.

Definition at line 29 of file RGBAMatrixColorScaleBitmapEffect.cs.

RGBAColor DirectOutput.FX.MatrixFX.RGBAMatrixColorScaleBitmapEffect.InactiveColor

getset

Gets or sets the inactive color. The FadeMode property defines how this value is used.

The inactive color.

Definition at line 44 of file RGBAMatrixColorScaleBitmapEffect.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/FX/MatrixFX/RGBAMatrixColorScaleBitmapEffect.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation