Package icyllis.arc3d.compiler

Class CodeGenerator

java.lang.Object

icyllis.arc3d.compiler.CodeGenerator

Direct Known Subclasses:

GLSLCodeGenerator, SPIRVCodeGenerator

public abstract class CodeGenerator
extends Object

Abstract superclass of all code generators, which take a TranslationUnit as input and produce code as output.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Context	mContext
protected final TranslationUnit	mTranslationUnit

Constructor Summary

Constructors

Constructor	Description
CodeGenerator(Context context, TranslationUnit translationUnit)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

mContext

protected final Context mContext

mTranslationUnit

protected final TranslationUnit mTranslationUnit

Constructor Details

CodeGenerator

public CodeGenerator(Context context,
 TranslationUnit translationUnit)

Method Details

generateCode

public abstract @Nullable ByteBuffer generateCode()

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().

Returns:

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

getContext

protected Context getContext()