JOGL 2.3.2 · com.jogamp.gluegen.opengl.GLConfiguration

Modifier and Type	Field and Description
private boolean	allowNonGLExtensions
private boolean	autoUnifyExtensions
private final Map<String, GLEmitter.BufferObjectKind>	bufferObjectKinds
private final Set<String>	bufferObjectOnly
pack-priv boolean	dropDocInfo
private final Set<String>	dropUniqVendorExtensions
private final GLEmitter	emitter
private final Set<String>	forcedExtensions
private final List<String>	glDocHeaders
private BuildStaticGLInfo	glDocInfo
private final List<String>	glSemHeaders
private BuildStaticGLInfo	glSemInfo
private final Set<String>	ignoredExtensions
private final Map<String, Set<String>>	javaDocRenamedSymbols
private final Map<String, String>	javaDocSymbolRenames
private final Set<String>	renameExtensionsIntoCore

Access	Constructor and Description
public	GLConfiguration(final GLEmitter emitter)

Method Summary

Modifier and Type	Method and Description
public void	addJavaDocSymbolRename(final String origName, final String newName) Adds a javadoc rename directive for the given symbol.
public void	addJavaSymbolRename(final String origName, final String newName) Overrides com.jogamp.gluegen.JavaConfiguration.addJavaSymbolRename. Programmatically adds a rename directive for the given symbol.
protected void	dispatch(final String cmd, final StringTokenizer tok, final File file, final String filename, final int lineNo) Overrides com.jogamp.gluegen.procaddress.ProcAddressConfiguration.dispatch.
public Set<String>	getAliasedDocNames(final AliasedSymbol the aliased symbol to retrieve the aliases symbol) Overrides com.jogamp.gluegen.JavaConfiguration.getAliasedDocNames. Return a set of aliased-name for comment in docs.
public boolean	getAllowNonGLExtensions() If true, accept all non encapsulated defines and functions, as it is mandatory for GL declarations.
public boolean	getAutoUnifyExtensions() Should we automatically ignore extensions that have already been fully subsumed into the OpenGL core namespace, and if they have not been, indicate which definition is not already in the core?
pack-priv GLEmitter.BufferObjectKind	getBufferObjectKind(final AliasedSymbol symbol) Returns the kind of buffer object this function deals with, or null if none.
public boolean	getDropUniqVendorExtensions(final String extName) shall the non unified (uniq) vendor extensions be dropped ?
public Set<String>	getExtensionsRenamedIntoCore() Returns the OpenGL extensions that should have all of their constant definitions and functions renamed into the core namespace; for example, glGenFramebuffersEXT to glGenFramebuffers and GL_FRAMEBUFFER_EXT to GL_FRAMEBUFFER.
public BuildStaticGLInfo	getGLDocInfo() Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. This instance targets API documentation information, i.e. not influencing code generation.
public BuildStaticGLInfo	getGLSemInfo() Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. This instance targets semantic information, i.e. influences code generation.
public Set<String>	getRenamedJavaDocSymbols(final String aliasedName) Returns a set of replaced javadoc names to the given `aliasedName`.
public boolean	isBufferObjectFunction(final AliasedSymbol symbol)
public boolean	isBufferObjectOnly(final String name)
protected boolean	isIgnoredExtension(final String extensionName)
public List<String>	javaPrologueForMethod(final MethodBinding binding, final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes) Overrides com.jogamp.gluegen.JavaConfiguration.javaPrologueForMethod. Overrides javaPrologueForMethod in superclass and automatically generates prologue code for functions associated with buffer objects.
public void	logIgnores() Overrides com.jogamp.gluegen.JavaConfiguration.logIgnores.
public void	logRenames() Overrides com.jogamp.gluegen.JavaConfiguration.logRenames.
public void	parseGLDocHeaders(final GlueEmitterControls controls) Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time.
public void	parseGLSemHeaders(final GlueEmitterControls controls) Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time.
protected void	readBufferObjectKind(final StringTokenizer tok, final String filename, final int lineNo)
public boolean	shouldForceExtension(final AliasedSymbol symbol, final Set<String> symExtensionNames)
protected boolean	shouldIgnoreExtension(final AliasedSymbol symbol)
public boolean	shouldIgnoreInImpl(final AliasedSymbol the symbolic aliased name to check for exclusion symbol) Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInImpl. Returns true if this aliased symbol should be ignored during glue code generation of implementation only.
public boolean	shouldIgnoreInInterface(final AliasedSymbol the symbolic aliased name to check for exclusion symbol) Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInInterface. Returns true if this aliased symbol should be ignored during glue code generation of interfaces and implementation.

allowNonGLExtensions	back to summary
private boolean allowNonGLExtensions

autoUnifyExtensions	back to summary
private boolean autoUnifyExtensions

bufferObjectKinds	back to summary
private final Map<String, GLEmitter.BufferObjectKind> bufferObjectKinds

bufferObjectOnly	back to summary
private final Set<String> bufferObjectOnly

dropDocInfo	back to summary
pack-priv boolean dropDocInfo

dropUniqVendorExtensions	back to summary
private final Set<String> dropUniqVendorExtensions

emitter	back to summary
private final GLEmitter emitter

forcedExtensions	back to summary
private final Set<String> forcedExtensions

glDocHeaders	back to summary
private final List<String> glDocHeaders

glDocInfo	back to summary
private BuildStaticGLInfo glDocInfo

glSemHeaders	back to summary
private final List<String> glSemHeaders

glSemInfo	back to summary
private BuildStaticGLInfo glSemInfo

ignoredExtensions	back to summary
private final Set<String> ignoredExtensions

javaDocRenamedSymbols	back to summary
private final Map<String, Set<String>> javaDocRenamedSymbols

javaDocSymbolRenames	back to summary
private final Map<String, String> javaDocSymbolRenames

renameExtensionsIntoCore	back to summary
private final Set<String> renameExtensionsIntoCore

GLConfiguration	back to summary
public GLConfiguration(final GLEmitter emitter)

Method Detail

addJavaDocSymbolRename	back to summary
public void addJavaDocSymbolRename(final String origName, final String newName) Adds a javadoc rename directive for the given symbol.

addJavaSymbolRename	back to summary
public void addJavaSymbolRename(final String origName, final String newName) Overrides com.jogamp.gluegen.JavaConfiguration.addJavaSymbolRename. Doc from com.jogamp.gluegen.JavaConfiguration.addJavaSymbolRename. Programmatically adds a rename directive for the given symbol. Also adds a javadoc rename directive for the given symbol. Annotations @Override

addJavaSymbolRename

back to summary

public void addJavaSymbolRename(final String origName, final String newName)

Overrides com.jogamp.gluegen.JavaConfiguration.addJavaSymbolRename.

Doc from com.jogamp.gluegen.JavaConfiguration.addJavaSymbolRename.

Programmatically adds a rename directive for the given symbol.

Also adds a javadoc rename directive for the given symbol.

Annotations

@Override

dispatch	back to summary
protected void dispatch(final String cmd, final StringTokenizer tok, final File file, final String filename, final int lineNo) throws IOException Overrides com.jogamp.gluegen.procaddress.ProcAddressConfiguration.dispatch. Annotations @Override

dispatch

back to summary

protected void dispatch(final String cmd, final StringTokenizer tok, final File file, final String filename, final int lineNo) throws IOException

Overrides com.jogamp.gluegen.procaddress.ProcAddressConfiguration.dispatch.

Annotations

@Override

getAliasedDocNames back to summary

getAliasedDocNames	back to summary
public Set<String> getAliasedDocNames(final AliasedSymbol symbol) Overrides com.jogamp.gluegen.JavaConfiguration.getAliasedDocNames. Doc from com.jogamp.gluegen.JavaConfiguration.getAliasedDocNames. Return a set of aliased-name for comment in docs. This is usually `AliasedSymbol#addAliasedName(String)`, however an implementation may choose otherwise. Parameters symbol:AliasedSymbol the aliased symbol to retrieve the aliases Returns:Set<String> set of aliased-names or `null`. Annotations @Override

public Set<String> getAliasedDocNames(final AliasedSymbol symbol)

Overrides com.jogamp.gluegen.JavaConfiguration.getAliasedDocNames.

Doc from com.jogamp.gluegen.JavaConfiguration.getAliasedDocNames.

Return a set of aliased-name for comment in docs.

This is usually AliasedSymbol#addAliasedName(String), however an implementation may choose otherwise.

Parameters

symbol:AliasedSymbol: the aliased symbol to retrieve the aliases

Returns:Set<String>

set of aliased-names or null.

Annotations

@Override

getAllowNonGLExtensions	back to summary
public boolean getAllowNonGLExtensions() If true, accept all non encapsulated defines and functions, as it is mandatory for GL declarations.

getAutoUnifyExtensions	back to summary
public boolean getAutoUnifyExtensions() Should we automatically ignore extensions that have already been fully subsumed into the OpenGL core namespace, and if they have not been, indicate which definition is not already in the core?

getBufferObjectKind	back to summary
pack-priv GLEmitter.BufferObjectKind getBufferObjectKind(final AliasedSymbol symbol) Returns the kind of buffer object this function deals with, or null if none.

getDropUniqVendorExtensions	back to summary
public boolean getDropUniqVendorExtensions(final String extName) shall the non unified (uniq) vendor extensions be dropped ?

getExtensionsRenamedIntoCore	back to summary
public Set<String> getExtensionsRenamedIntoCore() Returns the OpenGL extensions that should have all of their constant definitions and functions renamed into the core namespace; for example, glGenFramebuffersEXT to glGenFramebuffers and GL_FRAMEBUFFER_EXT to GL_FRAMEBUFFER.

getGLDocInfo	back to summary
public BuildStaticGLInfo getGLDocInfo() Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. This instance targets API documentation information, i.e. not influencing code generation. GLDocInfo include GLSemInfo!

getGLDocInfo

back to summary

public BuildStaticGLInfo getGLDocInfo()

Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in.

This instance targets API documentation information, i.e. not influencing code generation.

GLDocInfo include GLSemInfo!

getGLSemInfo	back to summary
public BuildStaticGLInfo getGLSemInfo() Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. This instance targets semantic information, i.e. influences code generation.

getGLSemInfo

back to summary

public BuildStaticGLInfo getGLSemInfo()

Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in.

This instance targets semantic information, i.e. influences code generation.

getRenamedJavaDocSymbols	back to summary
public Set<String> getRenamedJavaDocSymbols(final String aliasedName) Returns a set of replaced javadoc names to the given `aliasedName`.

isBufferObjectFunction	back to summary
public boolean isBufferObjectFunction(final AliasedSymbol symbol)

isBufferObjectOnly	back to summary
public boolean isBufferObjectOnly(final String name)

isIgnoredExtension	back to summary
protected boolean isIgnoredExtension(final String extensionName)

javaPrologueForMethod	back to summary
public List<String> javaPrologueForMethod(final MethodBinding binding, final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes) Overrides com.jogamp.gluegen.JavaConfiguration.javaPrologueForMethod. Overrides javaPrologueForMethod in superclass and automatically generates prologue code for functions associated with buffer objects. Annotations @Override

javaPrologueForMethod

back to summary

public List<String> javaPrologueForMethod(final MethodBinding binding, final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes)

Overrides com.jogamp.gluegen.JavaConfiguration.javaPrologueForMethod.

Overrides javaPrologueForMethod in superclass and automatically generates prologue code for functions associated with buffer objects.

Annotations

@Override

logIgnores	back to summary
public void logIgnores() Overrides com.jogamp.gluegen.JavaConfiguration.logIgnores. Annotations @Override

logIgnores

back to summary

public void logIgnores()

Overrides com.jogamp.gluegen.JavaConfiguration.logIgnores.

Annotations

@Override

logRenames	back to summary
public void logRenames() Overrides com.jogamp.gluegen.JavaConfiguration.logRenames. Annotations @Override

logRenames

back to summary

public void logRenames()

Overrides com.jogamp.gluegen.JavaConfiguration.logRenames.

Annotations

@Override

parseGLDocHeaders	back to summary
public void parseGLDocHeaders(final GlueEmitterControls controls) throws IOException Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time. Targeting API documentation information, i.e. not influencing code generation.

parseGLDocHeaders

back to summary

public void parseGLDocHeaders(final GlueEmitterControls controls) throws IOException

Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time.

Targeting API documentation information, i.e. not influencing code generation.

parseGLSemHeaders	back to summary
public void parseGLSemHeaders(final GlueEmitterControls controls) throws IOException Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time. Targeting semantic information, i.e. influences code generation.

parseGLSemHeaders

back to summary

public void parseGLSemHeaders(final GlueEmitterControls controls) throws IOException

Parses any GL headers specified in the configuration file for the purpose of being able to ignore an extension at a time.

Targeting semantic information, i.e. influences code generation.

readBufferObjectKind	back to summary
protected void readBufferObjectKind(final StringTokenizer tok, final String filename, final int lineNo)

shouldForceExtension	back to summary
public boolean shouldForceExtension(final AliasedSymbol symbol, final Set<String> symExtensionNames)

shouldIgnoreExtension	back to summary
protected boolean shouldIgnoreExtension(final AliasedSymbol symbol)

shouldIgnoreInImpl back to summary

shouldIgnoreInImpl	back to summary
public boolean shouldIgnoreInImpl(final AliasedSymbol symbol) Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInImpl. Doc from com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInImpl. Returns true if this aliased symbol should be ignored during glue code generation of implementation only. Both, the `current-name` and all `aliases` shall be considered. Implementation calls `shouldIgnoreInImpl_Int(AliasedSymbol)` and overriding implementations shall ensure its being called as well! Implementation extends the exclusion query w/ `the list of ignored extensions`. If passing the former, it calls down to `shouldIgnoreInImpl_Int(AliasedSymbol)`. Parameters symbol:AliasedSymbol the symbolic aliased name to check for exclusion Annotations @Override

public boolean shouldIgnoreInImpl(final AliasedSymbol symbol)

Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInImpl.

Doc from com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInImpl.

Returns true if this aliased symbol should be ignored during glue code generation of implementation only.

Both, the current-name and all aliases shall be considered.

Implementation calls shouldIgnoreInImpl_Int(AliasedSymbol) and overriding implementations shall ensure its being called as well!

Implementation extends the exclusion query w/ the list of ignored extensions.

If passing the former, it calls down to shouldIgnoreInImpl_Int(AliasedSymbol).

Parameters

symbol:AliasedSymbol: the symbolic aliased name to check for exclusion

Annotations

@Override

shouldIgnoreInInterface back to summary

shouldIgnoreInInterface	back to summary
public boolean shouldIgnoreInInterface(final AliasedSymbol symbol) Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInInterface. Doc from com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInInterface. Returns true if this aliased symbol should be ignored during glue code generation of interfaces and implementation. Both, the `current-name` and all `aliases` shall be considered. Implementation calls `shouldIgnoreInInterface_Int(AliasedSymbol)` and overriding implementations shall ensure its being called as well! Implementation extends the exclusion query w/ `the list of ignored extensions`. If passing the former, it calls down to `shouldIgnoreInInterface_Int(AliasedSymbol)`. Parameters symbol:AliasedSymbol the symbolic aliased name to check for exclusion Annotations @Override

public boolean shouldIgnoreInInterface(final AliasedSymbol symbol)

Overrides com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInInterface.

Doc from com.jogamp.gluegen.JavaConfiguration.shouldIgnoreInInterface.

Returns true if this aliased symbol should be ignored during glue code generation of interfaces and implementation.

Both, the current-name and all aliases shall be considered.

Implementation calls shouldIgnoreInInterface_Int(AliasedSymbol) and overriding implementations shall ensure its being called as well!

Implementation extends the exclusion query w/ the list of ignored extensions.

If passing the former, it calls down to shouldIgnoreInInterface_Int(AliasedSymbol).

Parameters