com.io7m.r2.filters

Class R2FilterFogDepth

java.lang.Object

com.io7m.r2.filters.R2FilterFogDepth

All Implemented Interfaces:

com.io7m.jcanephora.core.JCGLResourceUsableType, R2DeletableType, R2FilterType<R2FilterFogParameters>, R2FilterUsableType<R2FilterFogParameters>

public final class R2FilterFogDepth
extends Object
implements R2FilterType<R2FilterFogParameters>

A depth-based fog filter.

The filter takes a texture and a depth texture as input and writes a filtered image to the currently bound framebuffer.

See Also:

R2FilterFogParameters.imageTexture(), R2FilterFogParameters.imageDepthTexture()

Method Summary

Modifier and Type	Method and Description
void	delete(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g33) Delete the current object.
boolean	isDeleted()
static R2FilterType<R2FilterFogParameters>	newFilter(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type in_g, R2ShaderPreprocessingEnvironmentReadableType in_shader_env, R2IDPoolType in_pool, R2UnitQuadUsableType in_quad)
void	runFilter(com.io7m.jcanephora.profiler.JCGLProfilingContextType pc, com.io7m.jcanephora.texture_unit_allocator.JCGLTextureUnitContextParentType uc, R2FilterFogParameters parameters) Run the filter for the given parameters.

Methods inherited from class java.lang.Object

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

Method Detail

newFilter

public static R2FilterType<R2FilterFogParameters> newFilter(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type in_g,
                                                            R2ShaderPreprocessingEnvironmentReadableType in_shader_env,
                                                            R2IDPoolType in_pool,
                                                            R2UnitQuadUsableType in_quad)

Parameters:

in_g - An OpenGL interface

in_shader_env - Shader sources

in_pool - The ID pool

in_quad - A unit quad

Returns:

A new filter

delete

public void delete(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g33)
            throws R2Exception

Description copied from interface: R2DeletableType

Delete the current object.

Specified by:

delete in interface R2DeletableType

Parameters:

g33 - An OpenGL interface

Throws:

R2Exception - On errors

isDeleted

public boolean isDeleted()

Specified by:

isDeleted in interface com.io7m.jcanephora.core.JCGLResourceUsableType

runFilter

public void runFilter(com.io7m.jcanephora.profiler.JCGLProfilingContextType pc,
                      com.io7m.jcanephora.texture_unit_allocator.JCGLTextureUnitContextParentType uc,
                      R2FilterFogParameters parameters)

Description copied from interface: R2FilterUsableType

Run the filter for the given parameters.

Specified by:

runFilter in interface R2FilterUsableType<R2FilterFogParameters>

Parameters:

pc - A profiling context

uc - A texture unit context

parameters - The filter parameters