com.io7m.r2.filters

Class R2FilterOcclusionApplicatorParameters.Builder

java.lang.Object

com.io7m.r2.filters.R2FilterOcclusionApplicatorParameters.Builder

Enclosing class:

R2FilterOcclusionApplicatorParameters

public static final class R2FilterOcclusionApplicatorParameters.Builder
extends Object

Builds instances of type R2FilterOcclusionApplicatorParameters. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
R2FilterOcclusionApplicatorParameters	build() Builds a new R2FilterOcclusionApplicatorParameters.
R2FilterOcclusionApplicatorParameters.Builder	from(R2FilterOcclusionApplicatorParametersType instance) Fill a builder with attribute values from the provided R2FilterOcclusionApplicatorParametersType instance.
R2FilterOcclusionApplicatorParameters.Builder	setIntensity(float intensity) Initializes the value for the intensity attribute.
R2FilterOcclusionApplicatorParameters.Builder	setOcclusionTexture(R2Texture2DUsableType occlusionTexture) Initializes the value for the occlusionTexture attribute.
R2FilterOcclusionApplicatorParameters.Builder	setOutputLightBuffer(R2LightBufferUsableType outputLightBuffer) Initializes the value for the outputLightBuffer attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final R2FilterOcclusionApplicatorParameters.Builder from(R2FilterOcclusionApplicatorParametersType instance)

Fill a builder with attribute values from the provided R2FilterOcclusionApplicatorParametersType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setOutputLightBuffer

public final R2FilterOcclusionApplicatorParameters.Builder setOutputLightBuffer(R2LightBufferUsableType outputLightBuffer)

Initializes the value for the outputLightBuffer attribute.

Parameters:

outputLightBuffer - The value for outputLightBuffer

Returns:

this builder for use in a chained invocation

setOcclusionTexture

public final R2FilterOcclusionApplicatorParameters.Builder setOcclusionTexture(R2Texture2DUsableType occlusionTexture)

Initializes the value for the occlusionTexture attribute.

Parameters:

occlusionTexture - The value for occlusionTexture

Returns:

this builder for use in a chained invocation

setIntensity

public final R2FilterOcclusionApplicatorParameters.Builder setIntensity(float intensity)

Initializes the value for the intensity attribute.

If not set, this attribute will have a default value as returned by the initializer of intensity.

Parameters:

intensity - The value for intensity

Returns:

this builder for use in a chained invocation

build

public R2FilterOcclusionApplicatorParameters build()

Builds a new R2FilterOcclusionApplicatorParameters.

Returns:

An immutable instance of R2FilterOcclusionApplicatorParameters

Throws:

IllegalStateException - if any required attributes are missing