Package net.risingworld.api.objects.visuals

Class Vignette

java.lang.Object

net.risingworld.api.objects.visuals.Vignette

public final class Vignette
extends Object

Post-processing effect: Vignette effect (color applied to the corners of the screen). Used in conjunction with a PostProcessing object.

Constructor Summary

Constructors

Constructor	Description
Vignette()

Method Summary

Modifier and Type	Method	Description
float	getIntensity()
float	getRoundness()
float	getSmoothness()
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 intensity, float r, float g, float b, float smoothness, float roundness)	Sets the vignette effect.
void	set(float intensity, int color, float smoothness, float roundness)	Sets the vignette effect.

Methods inherited from class java.lang.Object

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

Constructor Details

Vignette

public Vignette()

Method Details

set

public void set(float intensity,
 float r,
 float g,
 float b,
 float smoothness,
 float roundness)

Sets the vignette effect.

Parameters:

intensity - the intensity of the vignette effect, between 0 and 1.

r - the red color component of the vignette effect (0-1).

g - the green color component of the vignette effect (0-1).

b - the blue color component of the vignette effect (0-1).

smoothness - the smoothness of the vignette effect, between 0 and 1. Default value is 1.

roundness - the roundness of the vignette effect, between 0 and 1. Default value is 1.

set

public void set(float intensity,
 int color,
 float smoothness,
 float roundness)

Sets the vignette effect.

Parameters:

intensity - the intensity of the vignette effect, between 0 and 1.

color - the RGB color of the vignette effect.

smoothness - the smoothness of the vignette effect, between 0 and 1. Default value is 1.

roundness - the roundness of the vignette effect, between 0 and 1. Default value is 1.

getIntensity

public float getIntensity()

getSmoothness

public float getSmoothness()

getRoundness

public float getRoundness()

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).