com.io7m.r2.filters

Class R2ShaderFilterBoxBlurParameters

java.lang.Object

com.io7m.r2.filters.R2ShaderFilterBoxBlurParameters

All Implemented Interfaces:

R2ShaderFilterBoxBlurParametersType

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

Parameters for box blur shaders

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
float	blurRadius()
static R2ShaderFilterBoxBlurParameters.Builder	builder() Creates a builder for R2ShaderFilterBoxBlurParameters.
static R2ShaderFilterBoxBlurParameters	copyOf(R2ShaderFilterBoxBlurParametersType instance) Creates an immutable copy of a R2ShaderFilterBoxBlurParametersType value.
boolean	equals(Object another) This instance is equal to all instances of R2ShaderFilterBoxBlurParameters that have equal attribute values.
int	hashCode() Computes a hash code from attributes: texture, blurRadius.
static R2ShaderFilterBoxBlurParameters	of(R2Texture2DUsableType texture, float blurRadius) Construct a new immutable R2ShaderFilterBoxBlurParameters instance.
R2Texture2DUsableType	texture()
String	toString() Prints the immutable value R2ShaderFilterBoxBlurParameters with attribute values.
R2ShaderFilterBoxBlurParameters	withBlurRadius(float value) Copy the current immutable object by setting a value for the blurRadius attribute.
R2ShaderFilterBoxBlurParameters	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 R2ShaderFilterBoxBlurParametersType

Returns:

The texture that contains occlusion values

blurRadius

public float blurRadius()

Specified by:

blurRadius in interface R2ShaderFilterBoxBlurParametersType

Returns:

The blur radius

withTexture

public final R2ShaderFilterBoxBlurParameters 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

withBlurRadius

public final R2ShaderFilterBoxBlurParameters withBlurRadius(float value)

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

Parameters:

value - A new value for blurRadius

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of R2ShaderFilterBoxBlurParameters 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, blurRadius.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value R2ShaderFilterBoxBlurParameters with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static R2ShaderFilterBoxBlurParameters of(R2Texture2DUsableType texture,
                                                 float blurRadius)

Construct a new immutable R2ShaderFilterBoxBlurParameters instance.

Parameters:

texture - The value for the texture attribute

blurRadius - The value for the blurRadius attribute

Returns:

An immutable R2ShaderFilterBoxBlurParameters instance

copyOf

public static R2ShaderFilterBoxBlurParameters copyOf(R2ShaderFilterBoxBlurParametersType instance)

Creates an immutable copy of a R2ShaderFilterBoxBlurParametersType 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 R2ShaderFilterBoxBlurParameters instance

builder

public static R2ShaderFilterBoxBlurParameters.Builder builder()

Creates a builder for R2ShaderFilterBoxBlurParameters.

Returns:

A new R2ShaderFilterBoxBlurParameters builder