Package net.risingworld.api.objects.visuals

Class WhiteBalance

java.lang.Object

net.risingworld.api.objects.visuals.WhiteBalance

public final class WhiteBalance
extends Object

Post-processing effect: White balance effect. Used in conjunction with a PostProcessing object.


White balance used to change the color temperature

Constructor Summary

Constructors

Constructor	Description
WhiteBalance()

Method Summary

Modifier and Type	Method	Description
float	getTemperature()
float	getTint()
boolean	isOverridden()	Determines if the effect is set.
void	reset()	Resets the effect, so it is no longer active (and no longer overrides any game effects).
void	set(float temperature, float tint)	Sets the white balance of the screen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WhiteBalance

public WhiteBalance()

Method Details

set

public void set(float temperature,
 float tint)

Sets the white balance of the screen. To reset the value to the game default value, call reset()

Parameters:

temperature - the screen color temperature, between -100 and +100. Negative values make the screen appear colder, positive values make the screen appear warmer. Default value is 0.

tint - optional screen tint color, between -100 and +100. Default value is 0.

getTemperature

public float getTemperature()

getTint

public float getTint()

reset

public void reset()

Resets the effect, so it is no longer active (and no longer overrides any game effects).

isOverridden

public boolean isOverridden()

Determines if the effect is set.

Returns:

true if this effect was set, false if not (or if it was reset).