com.io7m.r2.core.shaders.abstracts

Class R2AbstractLightProjectiveWithShadowShader<M extends R2LightProjectiveWithShadowReadableType>

java.lang.Object

com.io7m.r2.core.shaders.abstracts.R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M>

com.io7m.r2.core.shaders.abstracts.R2AbstractLightProjectiveWithShadowShader<M>

Type Parameters:

M - The type of shader parameters

All Implemented Interfaces:

com.io7m.jcanephora.core.JCGLResourceUsableType, R2DeletableType, R2ShaderLightProjectiveUsableType<M>, R2ShaderLightProjectiveWithShadowType<M>, R2ShaderLightProjectiveWithShadowUsableType<M>, R2ShaderLightSingleUsableType<M>, R2ShaderLightVolumeSingleType<M>, R2ShaderLightVolumeSingleUsableType<M>, R2ShaderType<M>, R2ShaderUsableType<M>

Direct Known Subclasses:

R2LightShaderProjectiveLambertBlinnPhongShadowVarianceSingle, R2LightShaderProjectiveLambertShadowVarianceSingle

public abstract class R2AbstractLightProjectiveWithShadowShader<M extends R2LightProjectiveWithShadowReadableType>
extends R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M>
implements R2ShaderLightProjectiveWithShadowType<M>

An abstract shader implementation that checks state transitions for correctness.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	R2AbstractLightProjectiveWithShadowShader.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	R2AbstractLightProjectiveWithShadowShader(com.io7m.jcanephora.core.api.JCGLShadersType in_shaders, R2ShaderPreprocessingEnvironmentReadableType in_shader_env, R2IDPoolType in_pool, String in_name, String in_vertex, Optional<String> in_geometry, String in_fragment, R2ShaderStateChecking in_check)

Method Summary

Modifier and Type	Method and Description
protected abstract void	onActualReceiveBoundGeometryBufferTextures(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2GeometryBufferUsableType gbuffer, com.io7m.jcanephora.core.JCGLTextureUnitType unit_albedo, com.io7m.jcanephora.core.JCGLTextureUnitType unit_specular, com.io7m.jcanephora.core.JCGLTextureUnitType unit_depth, com.io7m.jcanephora.core.JCGLTextureUnitType unit_normals)
protected abstract void	onActualReceiveProjectiveLight(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesProjectiveLightValuesType m)
protected abstract void	onActualReceiveShadowMap(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, com.io7m.jcanephora.texture.unit_allocator.JCGLTextureUnitContextMutableType tc, R2Texture2DUsableType map)
protected abstract void	onActualReceiveValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersLightType<M> light_parameters)
protected abstract void	onActualReceiveVolumeLightTransform(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesVolumeLightValuesType m)
protected void	onCheckActivated()
protected void	onCheckDeactivated()
protected com.io7m.jfsm.core.FSMEnumMutable<R2AbstractLightProjectiveWithShadowShader.State>	onCheckGetFSM()
protected void	onCheckValidated()
void	onReceiveBoundGeometryBufferTextures(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2GeometryBufferUsableType gbuffer, com.io7m.jcanephora.core.JCGLTextureUnitType unit_albedo, com.io7m.jcanephora.core.JCGLTextureUnitType unit_specular, com.io7m.jcanephora.core.JCGLTextureUnitType unit_depth, com.io7m.jcanephora.core.JCGLTextureUnitType unit_normals) Set the bound geometry buffer textures for the current shader.
void	onReceiveProjectiveLight(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesProjectiveLightValuesType m) Set shader values that are derived from the current projective light.
void	onReceiveShadowMap(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, com.io7m.jcanephora.texture.unit_allocator.JCGLTextureUnitContextMutableType tc, R2Texture2DUsableType map) Set values from the given shadow map context.
void	onReceiveValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersLightType<M> light_parameters) Set light values.
void	onReceiveVolumeLightTransform(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesVolumeLightValuesType m) Set shader values that are derived from the current volume light transform.

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

delete, environment, isDeleted, onActivate, onDeactivate, onValidate, 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.shaders.types.R2ShaderUsableType

environment, onActivate, onDeactivate, onValidate, shaderID, shaderParametersType, shaderProgram

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

isDeleted

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

delete, wrap

Constructor Detail

R2AbstractLightProjectiveWithShadowShader

protected R2AbstractLightProjectiveWithShadowShader(com.io7m.jcanephora.core.api.JCGLShadersType in_shaders,
                                                    R2ShaderPreprocessingEnvironmentReadableType in_shader_env,
                                                    R2IDPoolType in_pool,
                                                    String in_name,
                                                    String in_vertex,
                                                    Optional<String> in_geometry,
                                                    String in_fragment,
                                                    R2ShaderStateChecking in_check)
                                             throws R2ExceptionShaderPreprocessingFailed

Throws:

R2ExceptionShaderPreprocessingFailed

Method Detail

onReceiveShadowMap

public final void onReceiveShadowMap(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                     com.io7m.jcanephora.texture.unit_allocator.JCGLTextureUnitContextMutableType tc,
                                     R2Texture2DUsableType map)

Description copied from interface: R2ShaderLightProjectiveWithShadowUsableType

Set values from the given shadow map context.

This method will be called once for each projective light that uses the current shader.

This method will be called after a call to R2ShaderUsableType.onActivate(JCGLInterfaceGL33Type) and before a call to R2ShaderUsableType.onValidate().

Specified by:

onReceiveShadowMap in interface R2ShaderLightProjectiveWithShadowUsableType<M extends R2LightProjectiveWithShadowReadableType>

Parameters:

g - An OpenGL interface

tc - A texture unit context

map - A rendered shadow map

onReceiveProjectiveLight

public final void onReceiveProjectiveLight(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                           R2MatricesProjectiveLightValuesType m)

Description copied from interface: R2ShaderLightProjectiveUsableType

Set shader values that are derived from the current projective light.

This method will be called once for each projective light that uses the current shader.

This method will be called after a call to R2ShaderUsableType.onActivate(JCGLInterfaceGL33Type) and before a call to R2ShaderUsableType.onValidate().

Specified by:

onReceiveProjectiveLight in interface R2ShaderLightProjectiveUsableType<M extends R2LightProjectiveWithShadowReadableType>

Parameters:

g - An OpenGL interface

m - The instance matrices

onActualReceiveBoundGeometryBufferTextures

protected abstract void onActualReceiveBoundGeometryBufferTextures(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                                   R2GeometryBufferUsableType gbuffer,
                                                                   com.io7m.jcanephora.core.JCGLTextureUnitType unit_albedo,
                                                                   com.io7m.jcanephora.core.JCGLTextureUnitType unit_specular,
                                                                   com.io7m.jcanephora.core.JCGLTextureUnitType unit_depth,
                                                                   com.io7m.jcanephora.core.JCGLTextureUnitType unit_normals)

onActualReceiveValues

protected abstract void onActualReceiveValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                              R2ShaderParametersLightType<M> light_parameters)

onActualReceiveVolumeLightTransform

protected abstract void onActualReceiveVolumeLightTransform(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                            R2MatricesVolumeLightValuesType m)

onActualReceiveProjectiveLight

protected abstract void onActualReceiveProjectiveLight(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                       R2MatricesProjectiveLightValuesType m)

onActualReceiveShadowMap

protected abstract void onActualReceiveShadowMap(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                 com.io7m.jcanephora.texture.unit_allocator.JCGLTextureUnitContextMutableType tc,
                                                 R2Texture2DUsableType map)

onReceiveVolumeLightTransform

public final void onReceiveVolumeLightTransform(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                R2MatricesVolumeLightValuesType m)

Description copied from interface: R2ShaderLightVolumeSingleUsableType

Set shader values that are derived from the current volume light transform.

This method will be called exactly once for each light that uses the shader.

This method will be called after a call to R2ShaderUsableType.onActivate(JCGLInterfaceGL33Type) and before a call to R2ShaderUsableType.onValidate().

Specified by:

onReceiveVolumeLightTransform in interface R2ShaderLightVolumeSingleUsableType<M extends R2LightProjectiveWithShadowReadableType>

Parameters:

g - An OpenGL interface

m - The instance matrices

onReceiveBoundGeometryBufferTextures

public final void onReceiveBoundGeometryBufferTextures(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                       R2GeometryBufferUsableType gbuffer,
                                                       com.io7m.jcanephora.core.JCGLTextureUnitType unit_albedo,
                                                       com.io7m.jcanephora.core.JCGLTextureUnitType unit_specular,
                                                       com.io7m.jcanephora.core.JCGLTextureUnitType unit_depth,
                                                       com.io7m.jcanephora.core.JCGLTextureUnitType unit_normals)

Description copied from interface: R2ShaderLightSingleUsableType

Set the bound geometry buffer textures for the current shader.

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

Specified by:

onReceiveBoundGeometryBufferTextures in interface R2ShaderLightSingleUsableType<M extends R2LightProjectiveWithShadowReadableType>

Parameters:

g - An OpenGL interface

gbuffer - The geometry buffer

unit_albedo - The texture unit to which the geometry buffer's albedo/emissive texture is bound

unit_specular - The texture unit to which the geometry buffer's specular texture is bound

unit_depth - The texture unit to which the geometry buffer's depth/stencil texture is bound

unit_normals - The texture unit to which the geometry buffer's normal

onReceiveValues

public final void onReceiveValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                  R2ShaderParametersLightType<M> light_parameters)

Description copied from interface: R2ShaderLightSingleUsableType

Set light values.

This method will be called once for each light that uses the current shader.

This method will be called after a call to R2ShaderUsableType.onActivate(JCGLInterfaceGL33Type) and before a call to R2ShaderUsableType.onValidate().

Specified by:

onReceiveValues in interface R2ShaderLightSingleUsableType<M extends R2LightProjectiveWithShadowReadableType>

Parameters:

g - An OpenGL interface

light_parameters - The light parameters

onCheckGetFSM

protected final com.io7m.jfsm.core.FSMEnumMutable<R2AbstractLightProjectiveWithShadowShader.State> onCheckGetFSM()

Specified by:

onCheckGetFSM in class R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M extends R2LightProjectiveWithShadowReadableType>

onCheckActivated

protected final void onCheckActivated()

Specified by:

onCheckActivated in class R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M extends R2LightProjectiveWithShadowReadableType>

onCheckDeactivated

protected final void onCheckDeactivated()

Specified by:

onCheckDeactivated in class R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M extends R2LightProjectiveWithShadowReadableType>

onCheckValidated

protected final void onCheckValidated()

Specified by:

onCheckValidated in class R2AbstractShader<R2AbstractLightProjectiveWithShadowShader.State,M extends R2LightProjectiveWithShadowReadableType>