jme3tools.shadercheck
Interface Validator

All Known Implementing Classes:
CgcValidator, GpuAnalyzerValidator

public interface Validator

Interface for shader validator tools.


Method Summary
 java.lang.String getInstalledVersion()
          Returns the tool version as a string, must return null if the tool is not installed.
 java.lang.String getName()
          Returns the name of the validation tool
 boolean isInstalled()
          Returns true if the tool is installed on the system, false otherwise.
 void validate(Shader shader, java.lang.StringBuilder results)
          Validates the given shader to make sure it follows all requirements of the shader language specified as Shader.getLanguage().
 

Method Detail

getName

java.lang.String getName()
Returns the name of the validation tool


isInstalled

boolean isInstalled()
Returns true if the tool is installed on the system, false otherwise.


getInstalledVersion

java.lang.String getInstalledVersion()
Returns the tool version as a string, must return null if the tool is not installed.


validate

void validate(Shader shader,
              java.lang.StringBuilder results)
Validates the given shader to make sure it follows all requirements of the shader language specified as Shader.getLanguage(). The results of the validation will be written into the results argument.

Parameters:
shader - The shader to validate
results - The storage for the validation results