Package icyllis.arc3d.compiler.glsl

Class GLSLCodeGenerator

java.lang.Object

icyllis.arc3d.compiler.CodeGenerator

icyllis.arc3d.compiler.glsl.GLSLCodeGenerator

public final class GLSLCodeGenerator
extends CodeGenerator

Standard GLSL code generator for OpenGL 3.3 or above and Vulkan 1.0 or above (Vulkan GLSL).

A GLSL shader is a UTF-8 encoded string. However, our compiler only outputs ASCII characters.

Field Summary

Fields

Modifier and Type	Field	Description
final TargetApi	mOutputTarget
final GLSLVersion	mOutputVersion

Fields inherited from class icyllis.arc3d.compiler.CodeGenerator

mContext, mTranslationUnit

Constructor Summary

Constructors

Constructor	Description
GLSLCodeGenerator(@NonNull Context context, @NonNull TranslationUnit translationUnit, @NonNull ShaderCaps shaderCaps)

Method Summary

Modifier and Type	Method	Description
@Nullable ByteBuffer	generateCode()	Generates the code and returns a buffer slice.

Methods inherited from class icyllis.arc3d.compiler.CodeGenerator

getContext

Methods inherited from class java.lang.Object

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

Field Details

mOutputTarget

public final TargetApi mOutputTarget

mOutputVersion

public final GLSLVersion mOutputVersion

Constructor Details

GLSLCodeGenerator

public GLSLCodeGenerator(@NonNull Context context,
 @NonNull TranslationUnit translationUnit,
 @NonNull ShaderCaps shaderCaps)

Method Details

generateCode

public @Nullable ByteBuffer generateCode()

Description copied from class: CodeGenerator

Generates the code and returns a buffer slice. The code size in bytes is Buffer.remaining().

The return value is a direct buffer allocated via ByteBuffer.allocateDirect(int). The byte order is ByteOrder.nativeOrder() (i.e. host endianness) and it's safe to pass the result to OpenGL and Vulkan. There is no way to free this buffer explicitly, as it is subject to GC. Use Reference.reachabilityFence(Object) to keep it alive.

Check errors via Context.getErrorHandler().

Specified by:

generateCode in class CodeGenerator

Returns:

the generated code, or null if there's an error