@NonNullByDefault

# Package com.io7m.r2.filters

Default provided filters.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  R2BilateralBlurParametersType | The type of blur parameters specific to bilateral blurs.
  R2BlurParametersType | The type of blur parameters.
  R2EyePositionBufferType | The type of eye-position buffers.
  R2EyePositionBufferUsableType | The type of usable eye-space position buffers.
  R2EyeZBufferType | The type of eye-Z buffers.
  R2EyeZBufferUsableType | The type of usable eye-Z buffers.
  R2FilterBilateralBlurDepthAwareParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Parameters for bilateral blur filters that blur render targets of type `S` and write the blurred results to render targets of type `T`.
  R2FilterBoxBlurParametersType<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Parameters for box blur filters that blur render targets of type `S` and write the blurred results to render targets of type `T`.
  R2FilterCompositorBlendingType | Parameters for blending an image in the compositor.
  R2FilterCompositorItemType | A single texture that will be rendered to some subset of the current viewport.
  R2FilterCompositorParametersType | Parameters for filters that render textures to the current framebuffer.
  R2FilterDebugEyePositionParametersType | Parameters for filters that reproduce eye-space position values.
  R2FilterDebugEyeZParametersType | Parameters for filters that reproduce eye-space Z values.
  R2FilterEmissionParametersType | The type of parameters for emission filters.
  R2FilterFogParametersType | Parameters for the fog filter.
  R2FilterFXAAParametersType | The type of parameters for filters that apply anti-aliasing using the FXAA algorithm.
  R2FilterLightApplicatorParametersType | The type of light applicator filter parameters.
  R2FilterOcclusionApplicatorParametersType | The type of occlusion applicator filter parameters.
  R2FilterSSAOParametersType | The type of parameters for filters that calculate ambient occlusion in screen-space.
  R2ShaderFilterBilateralBlurDepthAwareParametersType | The type of parameters for bilateral depth-aware blur shaders.
  R2ShaderFilterBoxBlurParametersType | Parameters for box blur shaders
  R2ShaderFilterEmissionParametersType | Parameters for the emission shader.
  R2ShaderFilterFogParametersType | Parameters for the fog shader.
  R2ShaderFilterFXAAParametersType | Parameters for the FXAA shader.
  R2ShaderFilterLightApplicatorParametersType | Parameters for the light applicator shader
  R2ShaderFilterOcclusionApplicatorParametersType | Parameters for the occlusion applicator shader
  R2ShaderFilterTextureShowParametersType | Parameters for the texture display shader.
  R2ShaderSSAOParametersType | Parameters for the SSAO shader.
  R2SSAOKernelReadableType | The type of readable SSAO kernels.
  R2SSAOKernelType | The type of SSAO kernels.
  R2SSAOKernelWritableType | The type of writable SSAO kernels.

- Class Summary
  Class | Description
  --- | ---
  R2BilateralBlurParameters | The type of blur parameters specific to bilateral blurs.
  R2BilateralBlurParameters.Builder | Builds instances of type `R2BilateralBlurParameters`.
  R2BlurParameters | The type of blur parameters.
  R2BlurParameters.Builder | Builds instances of type `R2BlurParameters`.
  R2EyePositionBuffer | Default implementation of the `R2EyePositionBuffer` interface.
  R2EyeZBuffer | Default implementation of the `R2EyeZBufferType` interface.
  R2FilterBilateralBlurDepthAware<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | A generic box blur filter.
  R2FilterBilateralBlurDepthAwareParameters<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Parameters for bilateral blur filters that blur render targets of type `S` and write the blurred results to render targets of type `T`.
  R2FilterBilateralBlurDepthAwareParameters.Builder<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Builds instances of type `R2FilterBilateralBlurDepthAwareParameters`.
  R2FilterBoxBlur<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | A generic box blur filter.
  R2FilterBoxBlurParameters<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Parameters for box blur filters that blur render targets of type `S` and write the blurred results to render targets of type `T`.
  R2FilterBoxBlurParameters.Builder<SD extends R2RenderTargetDescriptionType,S extends R2RenderTargetUsableType<SD>,DD extends R2RenderTargetDescriptionType,D extends R2RenderTargetUsableType<DD>> | Builds instances of type `R2FilterBoxBlurParameters`.
  R2FilterCompositor | A compositor filter that combines textures.
  R2FilterCompositorItem | A single texture that will be rendered to some subset of the current viewport.
  R2FilterCompositorItem.Builder | Builds instances of type `R2FilterCompositorItem`.
  R2FilterCompositorParameters | Parameters for filters that render textures to the current framebuffer.
  R2FilterCompositorParameters.Builder | Builds instances of type `R2FilterCompositorParameters`.
  R2FilterDebugEyePosition | A filter that recovers the eye-space position of the pixels in the given geometry buffer.
  R2FilterDebugEyePositionParameters | Parameters for filters that reproduce eye-space position values.
  R2FilterDebugEyePositionParameters.Builder | Builds instances of type `R2FilterDebugEyePositionParameters`.
  R2FilterDebugEyeZ | A filter that recovers the eye-space Z position of the pixels in the given geometry buffer.
  R2FilterDebugEyeZParameters | Parameters for filters that reproduce eye-space Z values.
  R2FilterDebugEyeZParameters.Builder | Builds instances of type `R2FilterDebugEyeZParameters`.
  R2FilterEmission | The default implementation of the emission/glow filter.
  R2FilterEmissionParameters | The type of parameters for emission filters.
  R2FilterEmissionParameters.Builder | Builds instances of type `R2FilterEmissionParameters`.
  R2FilterFogDepth | A depth-based fog filter.
  R2FilterFogParameters | Parameters for the fog filter.
  R2FilterFogParameters.Builder | Builds instances of type `R2FilterFogParameters`.
  R2FilterFXAA | An FXAA filter.
  R2FilterFXAAParameters | The type of parameters for filters that apply anti-aliasing using the FXAA algorithm.
  R2FilterFXAAParameters.Builder | Builds instances of type `R2FilterFXAAParameters`.
  R2FilterLightApplicator | A trivial filter that combines a geometry buffer and a light buffer into a lit image.
  R2FilterLightApplicatorParameters | The type of light applicator filter parameters.
  R2FilterLightApplicatorParameters.Builder | Builds instances of type `R2FilterLightApplicatorParameters`.
  R2FilterOcclusionApplicator | A filter that applies ambient occlusion to a light buffer.
  R2FilterOcclusionApplicatorParameters | The type of occlusion applicator filter parameters.
  R2FilterOcclusionApplicatorParameters.Builder | Builds instances of type `R2FilterOcclusionApplicatorParameters`.
  R2FilterSSAO | A filter that calculates an ambient occlusion term from a given geometry buffer.
  R2FilterSSAOParameters | The type of parameters for filters that calculate ambient occlusion in screen-space.
  R2FilterSSAOParameters.Builder | Builds instances of type `R2FilterSSAOParameters`.
  R2ShaderFilterBilateralBlurDepthAwareHorizontal4f | A bilateral depth-aware blur horizontal RGBA shader.
  R2ShaderFilterBilateralBlurDepthAwareParameters | The type of parameters for bilateral depth-aware blur shaders.
  R2ShaderFilterBilateralBlurDepthAwareParameters.Builder | Builds instances of type `R2ShaderFilterBilateralBlurDepthAwareParameters`.
  R2ShaderFilterBilateralBlurDepthAwareVertical4f | A bilateral depth-aware blur vertical RGBA shader.
  R2ShaderFilterBoxBlurHorizontal4f | A horizontal RGBA box blur shader.
  R2ShaderFilterBoxBlurParameters | Parameters for box blur shaders
  R2ShaderFilterBoxBlurParameters.Builder | Builds instances of type `R2ShaderFilterBoxBlurParameters`.
  R2ShaderFilterBoxBlurVertical4f | A vertical RGBA box blur shader.
  R2ShaderFilterDebugEyePosition | A shader that recovers the eye-space position of the g-buffer surface.
  R2ShaderFilterDebugEyeZ | A shader that recovers the eye-space Z value of the g-buffer surface.
  R2ShaderFilterEmission | An emission shader that copies the emissive parts of an image.
  R2ShaderFilterEmissionParameters | Parameters for the emission shader.
  R2ShaderFilterEmissionParameters.Builder | Builds instances of type `R2ShaderFilterEmissionParameters`.
  R2ShaderFilterFogDepth | A shader that renders fog based on depth.
  R2ShaderFilterFogDepthLinear | A shader that renders linear fog based on depth.
  R2ShaderFilterFogDepthQuadratic | A shader that renders quadratic fog based on depth.
  R2ShaderFilterFogDepthQuadraticInverse | A shader that renders inverse quadratic fog based on depth.
  R2ShaderFilterFogParameters | Parameters for the fog shader.
  R2ShaderFilterFogParameters.Builder | Builds instances of type `R2ShaderFilterFogParameters`.
  R2ShaderFilterFXAAA | An FXAA shader.
  R2ShaderFilterFXAAParameters | Parameters for the FXAA shader.
  R2ShaderFilterFXAAParameters.Builder | Builds instances of type `R2ShaderFilterFXAAParameters`.
  R2ShaderFilterLightApplicator | A light applicator shader.
  R2ShaderFilterLightApplicatorParameters | Parameters for the light applicator shader
  R2ShaderFilterLightApplicatorParameters.Builder | Builds instances of type `R2ShaderFilterLightApplicatorParameters`.
  R2ShaderFilterOcclusionApplicator | An occlusion applicator shader.
  R2ShaderFilterOcclusionApplicatorParameters | Parameters for the occlusion applicator shader
  R2ShaderFilterOcclusionApplicatorParameters.Builder | Builds instances of type `R2ShaderFilterOcclusionApplicatorParameters`.
  R2ShaderFilterTextureShow | An image sink shader that copies a texture to the first output.
  R2ShaderFilterTextureShowParameters | Parameters for the texture display shader.
  R2ShaderFilterTextureShowParameters.Builder | Builds instances of type `R2ShaderFilterTextureShowParameters`.
  R2ShaderSSAO | An SSAO shader.
  R2ShaderSSAOParameters | Parameters for the SSAO shader.
  R2ShaderSSAOParameters.Builder | Builds instances of type `R2ShaderSSAOParameters`.
  R2SSAOKernel | The default implementation of the `R2SSAOKernelType` interface.
  R2SSAONoiseTexture | Functions for allocating noise textures for rotating SSAO kernels.

- Enum Summary
  Enum | Description
  --- | ---
  R2FilterFogProgression | The type of fog progression.
  R2FilterFXAAQuality | A specification of which FXAA preset to use, based on the desired quality level.

## Package com.io7m.r2.filters Description

Default provided filters.

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