R2ShaderFilterFogParameters (io7m-r2-documentation 0.2.0 API)

java.lang.Object
- com.io7m.r2.filters.R2ShaderFilterFogParameters

All Implemented Interfaces:: R2ShaderFilterFogParametersType

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

Parameters for the fog shader.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class R2ShaderFilterFogParameters.Builder
Builds instances of type R2ShaderFilterFogParameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`R2ShaderFilterFogParameters.Builder` Builds instances of type `R2ShaderFilterFogParameters`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static R2ShaderFilterFogParameters.Builder`	`builder()` Creates a builder for `R2ShaderFilterFogParameters`.
`static R2ShaderFilterFogParameters`	`copyOf(R2ShaderFilterFogParametersType instance)` Creates an immutable copy of a `R2ShaderFilterFogParametersType` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `R2ShaderFilterFogParameters` that have equal attribute values.
`com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType>`	`fogColor()`
`float`	`fogFarPositiveZ()` The positive eye-space Z value at which fog ends.
`float`	`fogNearPositiveZ()` The positive eye-space Z value at which fog starts.
`int`	`hashCode()` Computes a hash code from attributes: `imageTexture`, `imageDepthTexture`, `fogNearPositiveZ`, `fogFarPositiveZ`, `fogColor`, `observerValues`.
`R2Texture2DUsableType`	`imageDepthTexture()`
`R2Texture2DUsableType`	`imageTexture()`
`R2MatricesObserverValuesType`	`observerValues()`
`static R2ShaderFilterFogParameters`	`of(R2Texture2DUsableType imageTexture, R2Texture2DUsableType imageDepthTexture, float fogNearPositiveZ, float fogFarPositiveZ, com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType> fogColor, R2MatricesObserverValuesType observerValues)` Construct a new immutable `R2ShaderFilterFogParameters` instance.
`String`	`toString()` Prints the immutable value `R2ShaderFilterFogParameters` with attribute values.
`R2ShaderFilterFogParameters`	`withFogColor(com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType> value)` Copy the current immutable object by setting a value for the `fogColor` attribute.
`R2ShaderFilterFogParameters`	`withFogFarPositiveZ(float value)` Copy the current immutable object by setting a value for the `fogFarPositiveZ` attribute.
`R2ShaderFilterFogParameters`	`withFogNearPositiveZ(float value)` Copy the current immutable object by setting a value for the `fogNearPositiveZ` attribute.
`R2ShaderFilterFogParameters`	`withImageDepthTexture(R2Texture2DUsableType value)` Copy the current immutable object by setting a value for the `imageDepthTexture` attribute.
`R2ShaderFilterFogParameters`	`withImageTexture(R2Texture2DUsableType value)` Copy the current immutable object by setting a value for the `imageTexture` attribute.
`R2ShaderFilterFogParameters`	`withObserverValues(R2MatricesObserverValuesType value)` Copy the current immutable object by setting a value for the `observerValues` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - imageTexture
```
public R2Texture2DUsableType imageTexture()
```
    Specified by:
    
    imageTexture in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The input texture that will have fog applied
  - imageDepthTexture
```
public R2Texture2DUsableType imageDepthTexture()
```
    Specified by:
    
    imageDepthTexture in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The depth texture that contains logarithmic depth values
  - fogNearPositiveZ
```
public float fogNearPositiveZ()
```
    The positive eye-space Z value at which fog starts. Objects closer than this value have no fog applied.
    
    Specified by:
    
    fogNearPositiveZ in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The starting fog distance
  - fogFarPositiveZ
```
public float fogFarPositiveZ()
```
    The positive eye-space Z value at which fog ends. Objects further than this value are fully obscured by fog.
    
    Specified by:
    
    fogFarPositiveZ in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The ending fog distance
  - fogColor
```
public com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType> fogColor()
```
    Specified by:
    
    fogColor in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The color of the fog
  - observerValues
```
public R2MatricesObserverValuesType observerValues()
```
    Specified by:
    
    observerValues in interface R2ShaderFilterFogParametersType
    
    Returns:
    
    The observer matrix values that were used to produce the scene
  - withImageTexture
```
public final R2ShaderFilterFogParameters withImageTexture(R2Texture2DUsableType value)
```
    Copy the current immutable object by setting a value for the imageTexture attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for imageTexture
    
    Returns:
    
    A modified copy of the this object
  - withImageDepthTexture
```
public final R2ShaderFilterFogParameters withImageDepthTexture(R2Texture2DUsableType value)
```
    Copy the current immutable object by setting a value for the imageDepthTexture attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for imageDepthTexture
    
    Returns:
    
    A modified copy of the this object
  - withFogNearPositiveZ
```
public final R2ShaderFilterFogParameters withFogNearPositiveZ(float value)
```
    Copy the current immutable object by setting a value for the fogNearPositiveZ attribute. A value strict bits equality used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fogNearPositiveZ
    
    Returns:
    
    A modified copy of the this object
  - withFogFarPositiveZ
```
public final R2ShaderFilterFogParameters withFogFarPositiveZ(float value)
```
    Copy the current immutable object by setting a value for the fogFarPositiveZ attribute. A value strict bits equality used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fogFarPositiveZ
    
    Returns:
    
    A modified copy of the this object
  - withFogColor
```
public final R2ShaderFilterFogParameters withFogColor(com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType> value)
```
    Copy the current immutable object by setting a value for the fogColor attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fogColor
    
    Returns:
    
    A modified copy of the this object
  - withObserverValues
```
public final R2ShaderFilterFogParameters withObserverValues(R2MatricesObserverValuesType value)
```
    Copy the current immutable object by setting a value for the observerValues attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for observerValues
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of R2ShaderFilterFogParameters 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: imageTexture, imageDepthTexture, fogNearPositiveZ, fogFarPositiveZ, fogColor, observerValues.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value R2ShaderFilterFogParameters with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - of
```
public static R2ShaderFilterFogParameters of(R2Texture2DUsableType imageTexture,
                                             R2Texture2DUsableType imageDepthTexture,
                                             float fogNearPositiveZ,
                                             float fogFarPositiveZ,
                                             com.io7m.jtensors.parameterized.PVectorI3F<R2SpaceRGBType> fogColor,
                                             R2MatricesObserverValuesType observerValues)
```
    Construct a new immutable R2ShaderFilterFogParameters instance.
    
    Parameters:
    
    imageTexture - The value for the imageTexture attribute
    
    imageDepthTexture - The value for the imageDepthTexture attribute
    
    fogNearPositiveZ - The value for the fogNearPositiveZ attribute
    
    fogFarPositiveZ - The value for the fogFarPositiveZ attribute
    
    fogColor - The value for the fogColor attribute
    
    observerValues - The value for the observerValues attribute
    
    Returns:
    
    An immutable R2ShaderFilterFogParameters instance
  - copyOf
```
public static R2ShaderFilterFogParameters copyOf(R2ShaderFilterFogParametersType instance)
```
    Creates an immutable copy of a R2ShaderFilterFogParametersType 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 R2ShaderFilterFogParameters instance
  - builder
```
public static R2ShaderFilterFogParameters.Builder builder()
```
    Creates a builder for R2ShaderFilterFogParameters.
    
    Returns:
    
    A new R2ShaderFilterFogParameters builder

Class R2ShaderFilterFogParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

imageTexture

imageDepthTexture

fogNearPositiveZ

fogFarPositiveZ

fogColor

observerValues

withImageTexture

withImageDepthTexture

withFogNearPositiveZ

withFogFarPositiveZ

withFogColor

withObserverValues

equals

hashCode

toString

of

copyOf

builder