com.io7m.r2.filters

## Class R2FilterBoxBlurParameters<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>

- java.lang.Object
- - com.io7m.r2.filters.R2FilterBoxBlurParameters<SD,S,DD,D>

- Type Parameters:
    `SD` - The type of source render target descriptions
    `S` - The type of source render targets
    `DD` - The type of destination render target descriptions
    `D` - The type of destination render targets
  All Implemented Interfaces:
    R2FilterBoxBlurParametersType<SD,S,DD,D>

      @Generated(value={"Immutables.generator","R2FilterBoxBlurParametersType<SD, S, DD, D>"})
      public final class R2FilterBoxBlurParameters<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>
      extends Object
      implements R2FilterBoxBlurParametersType<SD,S,DD,D>

  Parameters for box blur filters that blur render targets of type `S` and write the blurred results to render targets of type `T`.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `R2FilterBoxBlurParameters.Builder<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>` Builds instances of type `R2FilterBoxBlurParameters`.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `R2BlurParameters` | `blurParameters()`
    `static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters.Builder<SD,S,DD,D>` | `builder()` Creates a builder for `R2FilterBoxBlurParameters`.
    `static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters<SD,S,DD,D>` | `copyOf(R2FilterBoxBlurParametersType<SD,S,DD,D> instance)` Creates an immutable copy of a `R2FilterBoxBlurParametersType` value.
    `boolean` | `equals(Object another)` This instance is equal to all instances of `R2FilterBoxBlurParameters` that have equal attribute values.
    `int` | `hashCode()` Computes a hash code from attributes: `sourceRenderTarget`, `sourceTextureSelector`, `outputRenderTarget`, `outputTextureSelector`, `renderTargetPool`, `blurParameters`, `outputDescriptionScaler`.
    `static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters<SD,S,DD,D>` | `of(S sourceRenderTarget, Function<S,R2Texture2DUsableType> sourceTextureSelector, D outputRenderTarget, Function<D,R2Texture2DUsableType> outputTextureSelector, R2RenderTargetPoolUsableType<DD,D> renderTargetPool, R2BlurParameters blurParameters, BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD> outputDescriptionScaler)` Construct a new immutable `R2FilterBoxBlurParameters` instance.
    `BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD>` | `outputDescriptionScaler()`
    `D` | `outputRenderTarget()`
    `Function<D,R2Texture2DUsableType>` | `outputTextureSelector()`
    `R2RenderTargetPoolUsableType<DD,D>` | `renderTargetPool()`
    `S` | `sourceRenderTarget()`
    `Function<S,R2Texture2DUsableType>` | `sourceTextureSelector()`
    `String` | `toString()` Prints the immutable value `R2FilterBoxBlurParameters` with attribute values.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withBlurParameters(R2BlurParameters value)` Copy the current immutable object by setting a value for the `blurParameters` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withOutputDescriptionScaler(BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD> value)` Copy the current immutable object by setting a value for the `outputDescriptionScaler` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withOutputRenderTarget(D value)` Copy the current immutable object by setting a value for the `outputRenderTarget` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withOutputTextureSelector(Function<D,R2Texture2DUsableType> value)` Copy the current immutable object by setting a value for the `outputTextureSelector` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withRenderTargetPool(R2RenderTargetPoolUsableType<DD,D> value)` Copy the current immutable object by setting a value for the `renderTargetPool` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withSourceRenderTarget(S value)` Copy the current immutable object by setting a value for the `sourceRenderTarget` attribute.
    `R2FilterBoxBlurParameters<SD,S,DD,D>` | `withSourceTextureSelector(Function<S,R2Texture2DUsableType> value)` Copy the current immutable object by setting a value for the `sourceTextureSelector` attribute.

    - ### Methods inherited from class java.lang.Object

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

- - ### Method Detail

    - #### sourceRenderTarget

          public S sourceRenderTarget()

      Specified by:
        `sourceRenderTarget` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        The source render target

    - #### sourceTextureSelector

          public Function<S,R2Texture2DUsableType> sourceTextureSelector()

      Specified by:
        `sourceTextureSelector` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        A function that, given a render target of type `S`, selects which texture on that render target will be used for blurring.

    - #### outputRenderTarget

          public D outputRenderTarget()

      Specified by:
        `outputRenderTarget` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        The output render target

    - #### outputTextureSelector

          public Function<D,R2Texture2DUsableType> outputTextureSelector()

      Specified by:
        `outputTextureSelector` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        A function that, given a render target of type `D`, selects which texture on that render target will be used for blurring.

    - #### renderTargetPool

          public R2RenderTargetPoolUsableType<DD,D> renderTargetPool()

      Specified by:
        `renderTargetPool` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        A pool used to construct temporary render targets

    - #### blurParameters

          public R2BlurParameters blurParameters()

      Specified by:
        `blurParameters` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        The blur parameters

    - #### outputDescriptionScaler

          public BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD> outputDescriptionScaler()

      Specified by:
        `outputDescriptionScaler` in interface `R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>>`
      Returns:
        A function that, given an existing description `D` and an area `A`, returns a new description with the values of `D` and the area `A`.

    - #### withSourceRenderTarget

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withSourceRenderTarget(S value)

      Copy the current immutable object by setting a value for the `sourceRenderTarget` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for sourceRenderTarget
      Returns:
        A modified copy of the `this` object

    - #### withSourceTextureSelector

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withSourceTextureSelector(Function<S,R2Texture2DUsableType> value)

      Copy the current immutable object by setting a value for the `sourceTextureSelector` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for sourceTextureSelector
      Returns:
        A modified copy of the `this` object

    - #### withOutputRenderTarget

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withOutputRenderTarget(D value)

      Copy the current immutable object by setting a value for the `outputRenderTarget` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for outputRenderTarget
      Returns:
        A modified copy of the `this` object

    - #### withOutputTextureSelector

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withOutputTextureSelector(Function<D,R2Texture2DUsableType> value)

      Copy the current immutable object by setting a value for the `outputTextureSelector` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for outputTextureSelector
      Returns:
        A modified copy of the `this` object

    - #### withRenderTargetPool

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withRenderTargetPool(R2RenderTargetPoolUsableType<DD,D> value)

      Copy the current immutable object by setting a value for the `renderTargetPool` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for renderTargetPool
      Returns:
        A modified copy of the `this` object

    - #### withBlurParameters

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withBlurParameters(R2BlurParameters value)

      Copy the current immutable object by setting a value for the `blurParameters` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for blurParameters
      Returns:
        A modified copy of the `this` object

    - #### withOutputDescriptionScaler

          public final R2FilterBoxBlurParameters<SD,S,DD,D> withOutputDescriptionScaler(BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD> value)

      Copy the current immutable object by setting a value for the `outputDescriptionScaler` attribute. A shallow reference equality check is used to prevent copying of the same value by returning `this`.
      Parameters:
        `value` - A new value for outputDescriptionScaler
      Returns:
        A modified copy of the `this` object

    - #### equals

          public boolean equals(Object another)

      This instance is equal to all instances of `R2FilterBoxBlurParameters` 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: `sourceRenderTarget`, `sourceTextureSelector`, `outputRenderTarget`, `outputTextureSelector`, `renderTargetPool`, `blurParameters`, `outputDescriptionScaler`.
      Overrides:
        `hashCode` in class `Object`
      Returns:
        hashCode value

    - #### toString

          public String toString()

      Prints the immutable value `R2FilterBoxBlurParameters` with attribute values.
      Overrides:
        `toString` in class `Object`
      Returns:
        A string representation of the value

    - #### of

          public static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters<SD,S,DD,D> of(S sourceRenderTarget,
                                                                                                                                                                                                                                  Function<S,R2Texture2DUsableType> sourceTextureSelector,
                                                                                                                                                                                                                                  D outputRenderTarget,
                                                                                                                                                                                                                                  Function<D,R2Texture2DUsableType> outputTextureSelector,
                                                                                                                                                                                                                                  R2RenderTargetPoolUsableType<DD,D> renderTargetPool,
                                                                                                                                                                                                                                  R2BlurParameters blurParameters,
                                                                                                                                                                                                                                  BiFunction<DD,com.io7m.jareas.core.AreaInclusiveUnsignedLType,DD> outputDescriptionScaler)

      Construct a new immutable `R2FilterBoxBlurParameters` instance.
      Parameters:
        `sourceRenderTarget` - The value for the `sourceRenderTarget` attribute
        `sourceTextureSelector` - The value for the `sourceTextureSelector` attribute
        `outputRenderTarget` - The value for the `outputRenderTarget` attribute
        `outputTextureSelector` - The value for the `outputTextureSelector` attribute
        `renderTargetPool` - The value for the `renderTargetPool` attribute
        `blurParameters` - The value for the `blurParameters` attribute
        `outputDescriptionScaler` - The value for the `outputDescriptionScaler` attribute
      Returns:
        An immutable R2FilterBoxBlurParameters instance

    - #### copyOf

          public static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters<SD,S,DD,D> copyOf(R2FilterBoxBlurParametersType<SD,S,DD,D> instance)

      Creates an immutable copy of a `R2FilterBoxBlurParametersType` value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Type Parameters:
        `SD` - generic parameter SD
        `S` - generic parameter S
        `DD` - generic parameter DD
        `D` - generic parameter D
      Parameters:
        `instance` - The instance to copy
      Returns:
        A copied immutable R2FilterBoxBlurParameters instance

    - #### builder

          public static <SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> R2FilterBoxBlurParameters.Builder<SD,S,DD,D> builder()

      Creates a builder for `R2FilterBoxBlurParameters`.
      Type Parameters:
        `SD` - generic parameter SD
        `S` - generic parameter S
        `DD` - generic parameter DD
        `D` - generic parameter D
      Returns:
        A new R2FilterBoxBlurParameters builder

Copyright © 2017 <code@io7m.com> http://io7m.com