Stay organized with collections
Save and categorize content based on your preferences.
LightingColorFilter
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
LightingColorFilter
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.
getColorMultiply
public int getColorMultiply ()
Returns the RGB color used to multiply the source color when the
color filter is applied.
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.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# LightingColorFilter\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nLightingColorFilter\n===================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/graphics/LightingColorFilter \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\n\nclass\nLightingColorFilter\n`\n\n\n`\n\n\n`\n\n`\n\nextends `[ColorFilter](/reference/android/graphics/ColorFilter)`\n\n\n`\n\n`\n\n\n`\n\n|---|---|--------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) |||\n| ↳ | [android.graphics.ColorFilter](/reference/android/graphics/ColorFilter) ||\n| | ↳ | android.graphics.LightingColorFilter |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA color filter that can be used to simulate simple lighting effects.\nA `LightingColorFilter` is defined by two parameters, one\nused to multiply the source color (called `colorMultiply`)\nand one used to add to the source color (called `colorAdd`).\nThe alpha channel is left untouched by this color filter.\n\nGiven a source color RGB, the resulting R'G'B' color is computed thusly: \n\n```\n R' = R * colorMultiply.R + colorAdd.R\n G' = G * colorMultiply.G + colorAdd.G\n B' = B * colorMultiply.B + colorAdd.B\n \n```\nThe result is pinned to the `[0..255]` range for each channel.\n\n\u003cbr /\u003e\n\nSummary\n-------\n\n| ### Public constructors ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[LightingColorFilter](/reference/android/graphics/LightingColorFilter#LightingColorFilter(int,%20int))`(int mul, int add) ` Create a colorfilter that multiplies the RGB channels by one color, and then adds a second color. |\n\n| ### Public methods ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` int` | ` `[getColorAdd](/reference/android/graphics/LightingColorFilter#getColorAdd())`() ` Returns the RGB color that will be added to the source color when the color filter is applied. |\n| ` int` | ` `[getColorMultiply](/reference/android/graphics/LightingColorFilter#getColorMultiply())`() ` Returns the RGB color used to multiply the source color when the color filter is applied. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(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](/reference/java/lang/Object#wait(long))`(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](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic constructors\n-------------------\n\n### LightingColorFilter\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic LightingColorFilter (int mul, \n int add)\n```\n\nCreate a colorfilter that multiplies the RGB channels by one color,\nand then adds a second color. The alpha components of the mul and add\narguments are ignored.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------|--------------|\n| `mul` | `int` \u003cbr /\u003e |\n| `add` | `int` \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### getColorAdd\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int getColorAdd ()\n```\n\nReturns the RGB color that will be added to the source color\nwhen the color filter is applied.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |\n\n### getColorMultiply\n\nAdded in [API level 26](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int getColorMultiply ()\n```\n\nReturns the RGB color used to multiply the source color when the\ncolor filter is applied.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |"]]
