LightingColorFilter

Summary: Ctors | Methods | Inherited Methods

public class LightingColorFilter
extends ColorFilter

A color filter that can be used to simulate simple lighting effects. A LightingColorFilter is defined by two parameters, one used to multiply the source color (called colorMultiply) and one used to add to the source color (called colorAdd). The alpha channel is left untouched by this color filter. Given a source color RGB, the resulting R'G'B' color is computed thusly:

 R' = R * colorMultiply.R + colorAdd.R
 G' = G * colorMultiply.G + colorAdd.G
 B' = B * colorMultiply.B + colorAdd.B

The result is pinned to the [0..255] range for each channel.

Summary

Public constructors
`LightingColorFilter(int mul, int add)` Create a colorfilter that multiplies the RGB channels by one color, and then adds a second color.

Public methods
`int`	`getColorAdd()` Returns the RGB color that will be added to the source color when the color filter is applied.
`int`	`getColorMultiply()` Returns the RGB color used to multiply the source color when the color filter is applied.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

public LightingColorFilter (int mul, 
                int add)

Create a colorfilter that multiplies the RGB channels by one color, and then adds a second color. The alpha components of the mul and add arguments are ignored.

Parameters
`mul`	`int`
`add`	`int`

Public methods

getColorAdd

public int getColorAdd ()

Returns the RGB color that will be added to the source color when the color filter is applied.

Returns
`int`

getColorMultiply

public int getColorMultiply ()

Returns the RGB color used to multiply the source color when the color filter is applied.

Returns
`int`

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.