stencyl.api.engine.utils.ColorMatrix

	Property	Defined By
		filter : ColorMatrixFilter [read-only]	ColorMatrix
		matrix : Array	ColorMatrix

	Method	Defined By
		ColorMatrix(mat:Object = null)	ColorMatrix
		adjustAlphaContrast(amount:Number = 0):void	ColorMatrix
		adjustBrightness(r:Number = 0, g:Number, b:Number):void	ColorMatrix
		adjustContrast(r:Number = 0, g:Number, b:Number):void	ColorMatrix
		adjustHue(degrees:Number = 0):void	ColorMatrix
		adjustSaturation(s:Number = 1):void	ColorMatrix
		applyColorDeficiency(type:String):void	ColorMatrix
		applyFilter(bitmapData:BitmapData):void	ColorMatrix
		applyMatrix(rgba:uint):uint	ColorMatrix
		autoDesaturate(bitmapData:BitmapData, stretchLevels:Boolean = false, outputToBlueOnly:Boolean = false):void	ColorMatrix
		average(r:Number, g:Number, b:Number):void	ColorMatrix
		averageRGB2Alpha():void	ColorMatrix
		blend(mat:ColorMatrix, amount:Number):void	ColorMatrix
		clearChannels(red:Boolean = false, green:Boolean = false, blue:Boolean = false, alpha:Boolean = false):void	ColorMatrix
		clone():ColorMatrix	ColorMatrix
		colorize(rgb:int, amount:Number = 1):void	ColorMatrix
		concat(mat:Array):void	ColorMatrix
		desaturate():void	ColorMatrix
		fitRange():void	ColorMatrix
		invert():void	ColorMatrix
		invertAlpha():void	ColorMatrix
		invertMatrix():Boolean	ColorMatrix
		luminance2Alpha():void	ColorMatrix
		normalize():void	ColorMatrix
		randomize(amount:Number = 1, donormalize:Boolean = false):void	ColorMatrix
		reset():void	ColorMatrix
		rgb2Alpha(r:Number, g:Number, b:Number):void	ColorMatrix
		RGB2YIQ():void	ColorMatrix
		RGB2YUV():void	ColorMatrix
		rotateBlue(degrees:Number = 0):void	ColorMatrix
		rotateGreen(degrees:Number = 0):void	ColorMatrix
		rotateHue(degrees:Number = 0):void	ColorMatrix
		rotateRed(degrees:Number = 0):void	ColorMatrix
		setAlpha(alpha:Number = 1):void	ColorMatrix
		setChannels(r:int = 1, g:int = 2, b:int = 4, a:int = 8):void	ColorMatrix
		setMultiplicators(red:Number = 1, green:Number = 1, blue:Number = 1, alpha:Number = 1):void	ColorMatrix
		shearBlue(red:Number, green:Number):void	ColorMatrix
		shearGreen(red:Number, blue:Number):void	ColorMatrix
		shearRed(green:Number, blue:Number):void	ColorMatrix
		threshold(threshold:Number, factor:Number = 256):void	ColorMatrix
		threshold_rgb(threshold:Number, factor:Number = 256):void	ColorMatrix
		thresholdAlpha(threshold:Number = 0.5, factor:Number = 256):void	ColorMatrix
		toGreyscale(r:Number, g:Number, b:Number):void	ColorMatrix
		toString():String	ColorMatrix
		transformVector(values:Array):void	ColorMatrix
		YUV2RGB():void	ColorMatrix

	Constant	Defined By
		COLOR_DEFICIENCY_TYPES : Array [static]	ColorMatrix

Property Detail

filter

property

filter:ColorMatrixFilter [read-only]

Implementation
public function get filter():ColorMatrixFilter

matrix

property

public var matrix:Array

Constructor Detail

ColorMatrix

()

Constructor

public function ColorMatrix(mat:Object = null)

Parameters

mat:Object (default = null)

Method Detail

adjustAlphaContrast

()

method

public function adjustAlphaContrast(amount:Number = 0):void

Parameters

amount:Number (default = 0)

adjustBrightness

()

method

public function adjustBrightness(r:Number = 0, g:Number, b:Number):void

Parameters

	`r:Number` (default = `0`)

	`g:Number` (default = `NaN`)

	`b:Number` (default = `NaN`)

adjustContrast

()

method

public function adjustContrast(r:Number = 0, g:Number, b:Number):void

Parameters

	`r:Number` (default = `0`)

	`g:Number` (default = `NaN`)

	`b:Number` (default = `NaN`)

adjustHue

()

method

public function adjustHue(degrees:Number = 0):void

Parameters

degrees:Number (default = 0)

adjustSaturation

()

method

public function adjustSaturation(s:Number = 1):void

Parameters

s:Number (default = 1)

applyColorDeficiency

()

method

public function applyColorDeficiency(type:String):void

Parameters

type:String

applyFilter

()

method

public function applyFilter(bitmapData:BitmapData):void

Parameters

bitmapData:BitmapData

applyMatrix

()

method

public function applyMatrix(rgba:uint):uint

Parameters

rgba:uint

Returns

uint

autoDesaturate

()

method

 public function autoDesaturate(bitmapData:BitmapData, stretchLevels:Boolean = false, outputToBlueOnly:Boolean = false):void

Parameters

	`bitmapData:BitmapData`

	`stretchLevels:Boolean` (default = `false`)

	`outputToBlueOnly:Boolean` (default = `false`)

average

()

method

public function average(r:Number, g:Number, b:Number):void

Parameters

	`r:Number` (default = `NaN`)

	`g:Number` (default = `NaN`)

	`b:Number` (default = `NaN`)

averageRGB2Alpha

()

method

public function averageRGB2Alpha():void

blend

()

method

public function blend(mat:ColorMatrix, amount:Number):void

Parameters

	`mat:ColorMatrix`

	`amount:Number`

clearChannels

()

method

 public function clearChannels(red:Boolean = false, green:Boolean = false, blue:Boolean = false, alpha:Boolean = false):void

Parameters

	`red:Boolean` (default = `false`)

	`green:Boolean` (default = `false`)

	`blue:Boolean` (default = `false`)

	`alpha:Boolean` (default = `false`)

clone

()

method

public function clone():ColorMatrix

Returns

ColorMatrix

colorize

()

method

public function colorize(rgb:int, amount:Number = 1):void

Parameters

	`rgb:int`

	`amount:Number` (default = `1`)

concat

()

method

public function concat(mat:Array):void

Parameters

mat:Array

desaturate

()

method

public function desaturate():void

fitRange

()

method

public function fitRange():void

invert

()

method

public function invert():void

invertAlpha

()

method

public function invertAlpha():void

invertMatrix

()

method

public function invertMatrix():Boolean

Returns

Boolean

luminance2Alpha

()

method

public function luminance2Alpha():void

normalize

()

method

public function normalize():void

randomize

()

method

public function randomize(amount:Number = 1, donormalize:Boolean = false):void

Parameters

	`amount:Number` (default = `1`)

	`donormalize:Boolean` (default = `false`)

reset

()

method

public function reset():void

rgb2Alpha

()

method

public function rgb2Alpha(r:Number, g:Number, b:Number):void

Parameters

	`r:Number` (default = `NaN`)

	`g:Number` (default = `NaN`)

	`b:Number` (default = `NaN`)

RGB2YIQ

()

method

public function RGB2YIQ():void

RGB2YUV

()

method

public function RGB2YUV():void

rotateBlue

()

method

public function rotateBlue(degrees:Number = 0):void

Parameters

degrees:Number (default = 0)

rotateGreen

()

method

public function rotateGreen(degrees:Number = 0):void

Parameters

degrees:Number (default = 0)

rotateHue

()

method

public function rotateHue(degrees:Number = 0):void

Parameters

degrees:Number (default = 0)

rotateRed

()

method

public function rotateRed(degrees:Number = 0):void

Parameters

degrees:Number (default = 0)

setAlpha

()

method

public function setAlpha(alpha:Number = 1):void

Parameters

alpha:Number (default = 1)

setChannels

()

method

public function setChannels(r:int = 1, g:int = 2, b:int = 4, a:int = 8):void

Parameters

	`r:int` (default = `1`)

	`g:int` (default = `2`)

	`b:int` (default = `4`)

	`a:int` (default = `8`)

setMultiplicators

()

method

public function setMultiplicators(red:Number = 1, green:Number = 1, blue:Number = 1, alpha:Number = 1):void

Parameters

	`red:Number` (default = `1`)

	`green:Number` (default = `1`)

	`blue:Number` (default = `1`)

	`alpha:Number` (default = `1`)

shearBlue

()

method

public function shearBlue(red:Number, green:Number):void

Parameters

	`red:Number`

	`green:Number`

shearGreen

()

method

public function shearGreen(red:Number, blue:Number):void

Parameters

	`red:Number`

	`blue:Number`

shearRed

()

method

public function shearRed(green:Number, blue:Number):void

Parameters

	`green:Number`

	`blue:Number`

threshold

()

method

public function threshold(threshold:Number, factor:Number = 256):void

Parameters

	`threshold:Number`

	`factor:Number` (default = `256`)

threshold_rgb

()

method

public function threshold_rgb(threshold:Number, factor:Number = 256):void

Parameters

	`threshold:Number`

	`factor:Number` (default = `256`)

thresholdAlpha

()

method

public function thresholdAlpha(threshold:Number = 0.5, factor:Number = 256):void

Parameters

	`threshold:Number` (default = `0.5`)

	`factor:Number` (default = `256`)

toGreyscale

()

method

public function toGreyscale(r:Number, g:Number, b:Number):void

Parameters

	`r:Number` (default = `NaN`)

	`g:Number` (default = `NaN`)

	`b:Number` (default = `NaN`)

toString

()

method

public function toString():String

Returns

String

transformVector

()

method

public function transformVector(values:Array):void

Parameters

values:Array

YUV2RGB

()

method

public function YUV2RGB():void

Constant Detail

COLOR_DEFICIENCY_TYPES

Constant

public static const COLOR_DEFICIENCY_TYPES:Array

Sun Apr 17 2011, 12:17 AM -07:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ColorMatrix	Properties \| Methods \| Constants

Package	stencyl.api.engine.utils
Class	public class ColorMatrix
Inheritance	ColorMatrix Object