com.io7m.r2.filters

Class R2ShaderFilterFogDepth

java.lang.Object

com.io7m.r2.core.shaders.provided.R2AbstractShader<R2ShaderFilterFogParameters>

com.io7m.r2.filters.R2ShaderFilterFogDepth

All Implemented Interfaces:

com.io7m.jcanephora.core.JCGLResourceUsableType, R2DeletableType, R2ShaderFilterType<R2ShaderFilterFogParameters>, R2ShaderFilterUsableType<R2ShaderFilterFogParameters>, R2ShaderScreenType<R2ShaderFilterFogParameters>, R2ShaderScreenUsableType<R2ShaderFilterFogParameters>, R2ShaderType<R2ShaderFilterFogParameters>, R2ShaderUsableType<R2ShaderFilterFogParameters>

Direct Known Subclasses:

R2ShaderFilterFogDepthLinear, R2ShaderFilterFogDepthQuadratic, R2ShaderFilterFogDepthQuadraticInverse

public abstract class R2ShaderFilterFogDepth
extends R2AbstractShader<R2ShaderFilterFogParameters>
implements R2ShaderFilterType<R2ShaderFilterFogParameters>

A shader that renders fog based on depth.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	R2ShaderFilterFogDepth(com.io7m.jcanephora.core.api.JCGLShadersType in_shaders, R2ShaderPreprocessingEnvironmentReadableType in_shader_env, R2IDPoolType in_pool, String type)

Method Summary

Modifier and Type	Method and Description
void	onReceiveFilterValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersFilterType<R2ShaderFilterFogParameters> parameters) Set filter values.
void	onValidate() Validate the shader prior to executing a draw call.
Class<R2ShaderFilterFogParameters>	shaderParametersType()

Methods inherited from class com.io7m.r2.core.shaders.provided.R2AbstractShader

delete, isDeleted, onActivate, onDeactivate, shaderID, shaderProgram

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.r2.core.R2DeletableType

delete

Methods inherited from interface com.io7m.r2.core.shaders.types.R2ShaderUsableType

onActivate, onDeactivate, shaderID, shaderProgram

Methods inherited from interface com.io7m.jcanephora.core.JCGLResourceUsableType

isDeleted

Constructor Detail

R2ShaderFilterFogDepth

protected R2ShaderFilterFogDepth(com.io7m.jcanephora.core.api.JCGLShadersType in_shaders,
                                 R2ShaderPreprocessingEnvironmentReadableType in_shader_env,
                                 R2IDPoolType in_pool,
                                 String type)

Method Detail

shaderParametersType

public final Class<R2ShaderFilterFogParameters> shaderParametersType()

Specified by:

shaderParametersType in interface R2ShaderUsableType<R2ShaderFilterFogParameters>

Returns:

The shader parameter type

onValidate

public final void onValidate()
                      throws R2ExceptionShaderValidationFailed

Description copied from interface: R2ShaderUsableType

Validate the shader prior to executing a draw call. This method exists so that shader implementations can check that the caller has called all required methods before drawing.

Specified by:

onValidate in interface R2ShaderUsableType<R2ShaderFilterFogParameters>

Throws:

R2ExceptionShaderValidationFailed - If validation fails

onReceiveFilterValues

public final void onReceiveFilterValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                        R2ShaderParametersFilterType<R2ShaderFilterFogParameters> parameters)

Description copied from interface: R2ShaderFilterUsableType

Set filter values.

This method will be called exactly once between calls to R2ShaderUsableType.onActivate(JCGLInterfaceGL33Type) and R2ShaderUsableType.onValidate().

Specified by:

onReceiveFilterValues in interface R2ShaderFilterUsableType<R2ShaderFilterFogParameters>

Parameters:

g - A texture interface

parameters - The current filter parameters