com.io7m.r2.core.shaders.abstracts

Class R2AbstractInstanceShaderSingle<M>

java.lang.Object

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

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

Type Parameters:

M - The type of shader parameters

All Implemented Interfaces:

com.io7m.jcanephora.core.JCGLResourceUsableType, R2DeletableType, R2ShaderInstanceSingleType<M>, R2ShaderInstanceSingleUsableType<M>, R2ShaderType<M>, R2ShaderUsableType<M>

Direct Known Subclasses:

R2MaskShaderSingle, R2ShaderDebugVisualSingle, R2ShaderLogDepthOnlySingle, R2StencilShaderSingle, R2SurfaceShaderBasicReflectiveSingle, R2SurfaceShaderBasicSingle, R2SurfaceShaderBasicStippledSingle

public abstract class R2AbstractInstanceShaderSingle<M>
extends R2AbstractShader<R2AbstractInstanceShaderSingle.State,M>
implements R2ShaderInstanceSingleType<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	R2AbstractInstanceShaderSingle.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	R2AbstractInstanceShaderSingle(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	onActualReceiveInstanceTransformValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesInstanceSingleValuesType m)
protected abstract void	onActualReceiveMaterialValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersMaterialType<M> mat_parameters)
protected abstract void	onActualReceiveViewValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersViewType view_parameters)
protected void	onCheckActivated()
protected void	onCheckDeactivated()
protected com.io7m.jfsm.core.FSMEnumMutable<R2AbstractInstanceShaderSingle.State>	onCheckGetFSM()
protected void	onCheckValidated()
void	onReceiveInstanceTransformValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2MatricesInstanceSingleValuesType m) Set shader values that are derived from the current instance transform.
void	onReceiveMaterialValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersMaterialType<M> mat_parameters) Set material values.
void	onReceiveViewValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g, R2ShaderParametersViewType view_parameters) Set shader values that are derived from the current view.

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.R2DeletableType

delete, wrap

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

Constructor Detail

R2AbstractInstanceShaderSingle

protected R2AbstractInstanceShaderSingle(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

onActualReceiveViewValues

protected abstract void onActualReceiveViewValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                  R2ShaderParametersViewType view_parameters)

onActualReceiveMaterialValues

protected abstract void onActualReceiveMaterialValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                      R2ShaderParametersMaterialType<M> mat_parameters)

onActualReceiveInstanceTransformValues

protected abstract void onActualReceiveInstanceTransformValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                               R2MatricesInstanceSingleValuesType m)

onCheckGetFSM

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

Specified by:

onCheckGetFSM in class R2AbstractShader<R2AbstractInstanceShaderSingle.State,M>

onCheckActivated

protected final void onCheckActivated()

Specified by:

onCheckActivated in class R2AbstractShader<R2AbstractInstanceShaderSingle.State,M>

onCheckDeactivated

protected final void onCheckDeactivated()

Specified by:

onCheckDeactivated in class R2AbstractShader<R2AbstractInstanceShaderSingle.State,M>

onCheckValidated

protected final void onCheckValidated()

Specified by:

onCheckValidated in class R2AbstractShader<R2AbstractInstanceShaderSingle.State,M>

onReceiveViewValues

public final void onReceiveViewValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                      R2ShaderParametersViewType view_parameters)

Description copied from interface: R2ShaderInstanceSingleUsableType

Set shader values that are derived from the current view.

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

Specified by:

onReceiveViewValues in interface R2ShaderInstanceSingleUsableType<M>

Parameters:

g - An OpenGL interface

view_parameters - The view parameters

onReceiveMaterialValues

public final void onReceiveMaterialValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                          R2ShaderParametersMaterialType<M> mat_parameters)

Description copied from interface: R2ShaderInstanceSingleUsableType

Set material values.

This method will be called once for each group of instances that use the material M.

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

Specified by:

onReceiveMaterialValues in interface R2ShaderInstanceSingleUsableType<M>

Parameters:

g - A texture interface

mat_parameters - The material parameters

onReceiveInstanceTransformValues

public final void onReceiveInstanceTransformValues(com.io7m.jcanephora.core.api.JCGLInterfaceGL33Type g,
                                                   R2MatricesInstanceSingleValuesType m)

Description copied from interface: R2ShaderInstanceSingleUsableType

Set shader values that are derived from the current instance transform.

This method will be called exactly once for each single instance 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:

onReceiveInstanceTransformValues in interface R2ShaderInstanceSingleUsableType<M>

Parameters:

g - An OpenGL interface

m - The instance matrices