com.io7m.r2.filters

Class R2FilterEmission

java.lang.Object

com.io7m.r2.filters.R2FilterEmission

All Implemented Interfaces:

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

public final class R2FilterEmission
extends Object
implements R2FilterType<R2FilterEmissionParameters>

The default implementation of the emission/glow filter.

Method Summary

Modifier and Type	Method and Description
void	delete(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type gx) Delete the current object.
boolean	isDeleted()
static R2FilterType<R2FilterEmissionParameters>	newFilter(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type in_g, R2ShaderPreprocessingEnvironmentReadableType in_shader_env, R2IDPoolType in_id_pool, R2FilterUsableType<R2FilterBoxBlurParameters<R2ImageBufferDescriptionType,R2ImageBufferUsableType,R2ImageBufferDescriptionType,R2ImageBufferUsableType>> in_blur, R2RenderTargetPoolUsableType<R2ImageBufferDescriptionType,R2ImageBufferUsableType> in_render_target_pool, R2UnitQuadUsableType in_quad) Construct a new emission filter.
void	runFilter(com.io7m.jcanephora.profiler.JCGLProfilingContextType pc, com.io7m.jcanephora.texture_unit_allocator.JCGLTextureUnitContextParentType uc, R2FilterEmissionParameters 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<R2FilterEmissionParameters> newFilter(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type in_g,
                                                                 R2ShaderPreprocessingEnvironmentReadableType in_shader_env,
                                                                 R2IDPoolType in_id_pool,
                                                                 R2FilterUsableType<R2FilterBoxBlurParameters<R2ImageBufferDescriptionType,R2ImageBufferUsableType,R2ImageBufferDescriptionType,R2ImageBufferUsableType>> in_blur,
                                                                 R2RenderTargetPoolUsableType<R2ImageBufferDescriptionType,R2ImageBufferUsableType> in_render_target_pool,
                                                                 R2UnitQuadUsableType in_quad)

Construct a new emission filter.

Parameters:

in_g - A GL interface

in_shader_env - Access to shader sources

in_id_pool - An ID pool

in_blur - A blur filter

in_render_target_pool - A pool of render targets for the blur filter

in_quad - A unit quad

Returns:

A new filter

delete

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

Description copied from interface: R2DeletableType

Delete the current object.

Specified by:

delete in interface R2DeletableType

Parameters:

gx - 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,
                      R2FilterEmissionParameters parameters)

Description copied from interface: R2FilterUsableType

Run the filter for the given parameters.

Specified by:

runFilter in interface R2FilterUsableType<R2FilterEmissionParameters>

Parameters:

pc - A profiling context

uc - A texture unit context

parameters - The filter parameters