JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.gluegen.opengl.GLConfiguration Class Reference
Inheritance diagram for com.jogamp.gluegen.opengl.GLConfiguration:
Collaboration diagram for com.jogamp.gluegen.opengl.GLConfiguration:

Public Member Functions

 GLConfiguration (final GLEmitter emitter)
 
List< String > javaPrologueForMethod (final MethodBinding binding, final boolean forImplementingMethodCall, final boolean eraseBufferAndArrayTypes)
 Overrides javaPrologueForMethod in superclass and automatically generates prologue code for functions associated with buffer objects. More...
 
void logIgnores ()
 
void logRenames ()
 
boolean shouldForceExtension (final AliasedSymbol symbol, final Set< String > symExtensionNames)
 
boolean shouldIgnoreInInterface (final AliasedSymbol symbol)
 
boolean shouldIgnoreInImpl (final AliasedSymbol symbol)
 
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? More...
 
boolean getAllowNonGLExtensions ()
 If true, accept all non encapsulated defines and functions, as it is mandatory for GL declarations. More...
 
boolean getDropUniqVendorExtensions (final String extName)
 shall the non unified (uniq) vendor extensions be dropped ?
More...
 
boolean isBufferObjectFunction (final AliasedSymbol symbol)
 
boolean isBufferObjectOnly (final String name)
 
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. More...
 
BuildStaticGLInfo getGLSemInfo ()
 Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. More...
 
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. More...
 
Set< String > getAliasedDocNames (final AliasedSymbol symbol)
 
BuildStaticGLInfo getGLDocInfo ()
 Returns the information about the association between #defines, function symbols and the OpenGL extensions they are defined in. More...
 
Set< String > getRenamedJavaDocSymbols (final String aliasedName)
 Returns a set of replaced javadoc names to the given aliasedName. More...
 
void addJavaSymbolRename (final String origName, final String newName)
 
void addJavaDocSymbolRename (final String origName, final String newName)
 Adds a javadoc rename directive for the given symbol. More...
 
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. More...
 

Protected Member Functions

void dispatch (final String cmd, final StringTokenizer tok, final File file, final String filename, final int lineNo) throws IOException
 
void readBufferObjectKind (final StringTokenizer tok, final String filename, final int lineNo)
 
boolean isIgnoredExtension (final String extensionName)
 
boolean shouldIgnoreExtension (final AliasedSymbol symbol)
 

Detailed Description

Definition at line 63 of file GLConfiguration.java.

Constructor & Destructor Documentation

◆ GLConfiguration()

com.jogamp.gluegen.opengl.GLConfiguration.GLConfiguration ( final GLEmitter  emitter)

Definition at line 92 of file GLConfiguration.java.

Member Function Documentation

◆ addJavaDocSymbolRename()

void com.jogamp.gluegen.opengl.GLConfiguration.addJavaDocSymbolRename ( final String  origName,
final String  newName 
)

Adds a javadoc rename directive for the given symbol.

Definition at line 504 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ addJavaSymbolRename()

void com.jogamp.gluegen.opengl.GLConfiguration.addJavaSymbolRename ( final String  origName,
final String  newName 
)

Also adds a javadoc rename directive for the given symbol.

Definition at line 494 of file GLConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dispatch()

void com.jogamp.gluegen.opengl.GLConfiguration.dispatch ( final String  cmd,
final StringTokenizer  tok,
final File  file,
final String  filename,
final int  lineNo 
) throws IOException
protected

Definition at line 103 of file GLConfiguration.java.

Here is the call graph for this function:

◆ getAliasedDocNames()

Set< String > com.jogamp.gluegen.opengl.GLConfiguration.getAliasedDocNames ( final AliasedSymbol  symbol)

Definition at line 464 of file GLConfiguration.java.

Here is the call graph for this function:

◆ getAllowNonGLExtensions()

boolean com.jogamp.gluegen.opengl.GLConfiguration.getAllowNonGLExtensions ( )

If true, accept all non encapsulated defines and functions, as it is mandatory for GL declarations.

Definition at line 381 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ getAutoUnifyExtensions()

boolean com.jogamp.gluegen.opengl.GLConfiguration.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?

Definition at line 375 of file GLConfiguration.java.

◆ getDropUniqVendorExtensions()

boolean com.jogamp.gluegen.opengl.GLConfiguration.getDropUniqVendorExtensions ( final String  extName)

shall the non unified (uniq) vendor extensions be dropped ?

Definition at line 386 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ getExtensionsRenamedIntoCore()

Set< String > com.jogamp.gluegen.opengl.GLConfiguration.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.

Definition at line 524 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ getGLDocInfo()

BuildStaticGLInfo com.jogamp.gluegen.opengl.GLConfiguration.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!

Definition at line 478 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ getGLSemInfo()

BuildStaticGLInfo com.jogamp.gluegen.opengl.GLConfiguration.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.

Definition at line 438 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ getRenamedJavaDocSymbols()

Set< String > com.jogamp.gluegen.opengl.GLConfiguration.getRenamedJavaDocSymbols ( final String  aliasedName)

Returns a set of replaced javadoc names to the given aliasedName.

Definition at line 483 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ isBufferObjectFunction()

boolean com.jogamp.gluegen.opengl.GLConfiguration.isBufferObjectFunction ( final AliasedSymbol  symbol)

Definition at line 402 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ isBufferObjectOnly()

boolean com.jogamp.gluegen.opengl.GLConfiguration.isBufferObjectOnly ( final String  name)

Definition at line 406 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ isIgnoredExtension()

boolean com.jogamp.gluegen.opengl.GLConfiguration.isIgnoredExtension ( final String  extensionName)
protected

Definition at line 257 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ javaPrologueForMethod()

List< String > com.jogamp.gluegen.opengl.GLConfiguration.javaPrologueForMethod ( final MethodBinding  binding,
final boolean  forImplementingMethodCall,
final boolean  eraseBufferAndArrayTypes 
)

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

Definition at line 177 of file GLConfiguration.java.

Here is the call graph for this function:

◆ logIgnores()

void com.jogamp.gluegen.opengl.GLConfiguration.logIgnores ( )

Definition at line 236 of file GLConfiguration.java.

◆ logRenames()

void com.jogamp.gluegen.opengl.GLConfiguration.logRenames ( )

Definition at line 249 of file GLConfiguration.java.

◆ parseGLDocHeaders()

void com.jogamp.gluegen.opengl.GLConfiguration.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.

Definition at line 449 of file GLConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ parseGLSemHeaders()

void com.jogamp.gluegen.opengl.GLConfiguration.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.

Definition at line 417 of file GLConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readBufferObjectKind()

void com.jogamp.gluegen.opengl.GLConfiguration.readBufferObjectKind ( final StringTokenizer  tok,
final String  filename,
final int  lineNo 
)
protected

Definition at line 145 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ shouldForceExtension()

boolean com.jogamp.gluegen.opengl.GLConfiguration.shouldForceExtension ( final AliasedSymbol  symbol,
final Set< String >  symExtensionNames 
)

Definition at line 333 of file GLConfiguration.java.

Here is the caller graph for this function:

◆ shouldIgnoreExtension()

boolean com.jogamp.gluegen.opengl.GLConfiguration.shouldIgnoreExtension ( final AliasedSymbol  symbol)
protected

Definition at line 265 of file GLConfiguration.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ shouldIgnoreInImpl()

boolean com.jogamp.gluegen.opengl.GLConfiguration.shouldIgnoreInImpl ( final AliasedSymbol  symbol)

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

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

Definition at line 368 of file GLConfiguration.java.

Here is the call graph for this function:

◆ shouldIgnoreInInterface()

boolean com.jogamp.gluegen.opengl.GLConfiguration.shouldIgnoreInInterface ( final AliasedSymbol  symbol)

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

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

Definition at line 354 of file GLConfiguration.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: