com.io7m.r2.filters

Class R2ShaderFilterOcclusionApplicatorParameters

java.lang.Object

com.io7m.r2.filters.R2ShaderFilterOcclusionApplicatorParameters

All Implemented Interfaces:

R2ShaderFilterOcclusionApplicatorParametersType

@Generated(value={"Immutables.generator","R2ShaderFilterOcclusionApplicatorParametersType"})
public final class R2ShaderFilterOcclusionApplicatorParameters
extends Object
implements R2ShaderFilterOcclusionApplicatorParametersType

Parameters for the occlusion applicator shader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	R2ShaderFilterOcclusionApplicatorParameters.Builder Builds instances of type R2ShaderFilterOcclusionApplicatorParameters.

Method Summary

Modifier and Type	Method and Description
static R2ShaderFilterOcclusionApplicatorParameters.Builder	builder() Creates a builder for R2ShaderFilterOcclusionApplicatorParameters.
static R2ShaderFilterOcclusionApplicatorParameters	copyOf(R2ShaderFilterOcclusionApplicatorParametersType instance) Creates an immutable copy of a R2ShaderFilterOcclusionApplicatorParametersType value.
boolean	equals(Object another) This instance is equal to all instances of R2ShaderFilterOcclusionApplicatorParameters that have equal attribute values.
int	hashCode() Computes a hash code from attributes: texture, intensity.
float	intensity()
static R2ShaderFilterOcclusionApplicatorParameters	of(R2Texture2DUsableType texture, float intensity) Construct a new immutable R2ShaderFilterOcclusionApplicatorParameters instance.
R2Texture2DUsableType	texture()
String	toString() Prints the immutable value R2ShaderFilterOcclusionApplicatorParameters with attribute values.
R2ShaderFilterOcclusionApplicatorParameters	withIntensity(float value) Copy the current immutable object by setting a value for the intensity attribute.
R2ShaderFilterOcclusionApplicatorParameters	withTexture(R2Texture2DUsableType value) Copy the current immutable object by setting a value for the texture attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

texture

public R2Texture2DUsableType texture()

Specified by:

texture in interface R2ShaderFilterOcclusionApplicatorParametersType

Returns:

The texture that contains occlusion values

intensity

public float intensity()

Specified by:

intensity in interface R2ShaderFilterOcclusionApplicatorParametersType

Returns:

The occlusion intensity

withTexture

public final R2ShaderFilterOcclusionApplicatorParameters withTexture(R2Texture2DUsableType value)

Copy the current immutable object by setting a value for the texture attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for texture

Returns:

A modified copy of the this object

withIntensity

public final R2ShaderFilterOcclusionApplicatorParameters withIntensity(float value)

Copy the current immutable object by setting a value for the intensity attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for intensity

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of R2ShaderFilterOcclusionApplicatorParameters that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: texture, intensity.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value R2ShaderFilterOcclusionApplicatorParameters with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static R2ShaderFilterOcclusionApplicatorParameters of(R2Texture2DUsableType texture,
                                                             float intensity)

Construct a new immutable R2ShaderFilterOcclusionApplicatorParameters instance.

Parameters:

texture - The value for the texture attribute

intensity - The value for the intensity attribute

Returns:

An immutable R2ShaderFilterOcclusionApplicatorParameters instance

copyOf

public static R2ShaderFilterOcclusionApplicatorParameters copyOf(R2ShaderFilterOcclusionApplicatorParametersType instance)

Creates an immutable copy of a R2ShaderFilterOcclusionApplicatorParametersType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable R2ShaderFilterOcclusionApplicatorParameters instance

builder

public static R2ShaderFilterOcclusionApplicatorParameters.Builder builder()

Creates a builder for R2ShaderFilterOcclusionApplicatorParameters.

Returns:

A new R2ShaderFilterOcclusionApplicatorParameters builder