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

Protected Member Functions

String getOutputName ()
 Get the output name for this pipeline class. More...
 
int getMode ()
 
boolean emptyMethodAllowed ()
 
boolean emptyDownstreamAllowed ()
 
void preMethodEmissionHook (final PrintWriter output)
 Called after the class headers have been generated, but before any method wrappers have been generated. More...
 
void constructorHook (final PrintWriter output)
 Emits the constructor for the pipeline; called after the preMethodEmissionHook. More...
 
void postMethodEmissionHook (final PrintWriter output)
 Called after the method wrappers have been generated, but before the closing parenthesis of the class is emitted. More...
 
void emitClassDocComment (final PrintWriter output)
 Emit a Javadoc comment for this pipeline class. More...
 
boolean hasPreDownstreamCallHook (final PlainMethod pm)
 
void preDownstreamCallHook (final PrintWriter output, final PlainMethod pm)
 Called before the pipeline routes the call to the downstream object. More...
 
boolean hasPostDownstreamCallHook (final PlainMethod pm)
 
void postDownstreamCallHook (final PrintWriter output, final PlainMethod pm)
 Called after the pipeline has routed the call to the downstream object, but before the calling function exits or returns a value. More...
 
- Protected Member Functions inherited from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter
String getDownstreamObjectName ()
 Get the name of the object through which API calls should be routed. More...
 
String getPrologObjectNameOpt ()
 Get the name of the object which shall be called as a prolog. More...
 
void emitMethodDocComment (final PrintWriter output, final Method m)
 
void emitSignature (final PrintWriter output, final Method m)
 
void emitBody (final PrintWriter output, final PlainMethod pm)
 
String getArgListAsString (final Method m, final boolean includeArgTypes, final boolean includeArgNames)
 
String getBaseInterfaceName ()
 The name of the class around which this pipeline is being composed. More...
 
abstract String getOutputName ()
 Get the output name for this pipeline class. More...
 
void preMethodEmissionHook (final PrintWriter output)
 Called after the class headers have been generated, but before any method wrappers have been generated. More...
 
abstract void constructorHook (PrintWriter output)
 Emits the constructor for the pipeline; called after the preMethodEmissionHook. More...
 
void postMethodEmissionHook (final PrintWriter output)
 Called after the method wrappers have been generated, but before the closing parenthesis of the class is emitted. More...
 
abstract void preDownstreamCallHook (PrintWriter output, PlainMethod pm)
 Called before the pipeline routes the call to the downstream object. More...
 
abstract boolean hasPreDownstreamCallHook (PlainMethod pm)
 
abstract void postDownstreamCallHook (PrintWriter output, PlainMethod pm)
 Called after the pipeline has routed the call to the downstream object, but before the calling function exits or returns a value. More...
 
abstract boolean hasPostDownstreamCallHook (PlainMethod pm)
 
abstract int getMode ()
 
abstract boolean emptyMethodAllowed ()
 
abstract boolean emptyDownstreamAllowed ()
 
abstract void emitClassDocComment (PrintWriter output)
 Emit a Javadoc comment for this pipeline class. More...
 
void emitGLIsMethodBody (final PrintWriter output, final PlainMethod plainMethod)
 Emits one of the isGL* methods. More...
 
void emitGLGetMethodBody (final PrintWriter output, final PlainMethod plainMethod)
 Emits one of the getGL* methods. More...
 
void emitSyntheticGLMethods (final PrintWriter output)
 Emits all synthetic GL* methods, but not isGL* nor getGL*. More...
 

Additional Inherited Members

- Public Member Functions inherited from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter
void emit (final Iterator< PlainMethod > methodsToWrap) throws IOException
 
- Protected Attributes inherited from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter
String basePackage
 
String baseName
 
String downstreamPackage
 
String downstreamName
 
String prologPackageOpt = null
 
String prologNameOpt = null
 
String outputDir
 
String outputPackage
 
Class<?> baseInterfaceClass
 
Class<?> prologClassOpt = null
 
Class<?> downstreamClass
 

Detailed Description

Definition at line 841 of file BuildComposablePipeline.java.

Member Function Documentation

◆ constructorHook()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.constructorHook ( final PrintWriter  output)
protected

Emits the constructor for the pipeline; called after the preMethodEmissionHook.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 876 of file BuildComposablePipeline.java.

Here is the call graph for this function:

◆ emitClassDocComment()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.emitClassDocComment ( final PrintWriter  output)
protected

Emit a Javadoc comment for this pipeline class.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 954 of file BuildComposablePipeline.java.

◆ emptyDownstreamAllowed()

boolean com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.emptyDownstreamAllowed ( )
protected

◆ emptyMethodAllowed()

boolean com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.emptyMethodAllowed ( )
protected

◆ getMode()

int com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.getMode ( )
protected

◆ getOutputName()

String com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.getOutputName ( )
protected

Get the output name for this pipeline class.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 851 of file BuildComposablePipeline.java.

Here is the caller graph for this function:

◆ hasPostDownstreamCallHook()

boolean com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.hasPostDownstreamCallHook ( final PlainMethod  pm)
protected

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 982 of file BuildComposablePipeline.java.

Here is the call graph for this function:

◆ hasPreDownstreamCallHook()

boolean com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.hasPreDownstreamCallHook ( final PlainMethod  pm)
protected

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 972 of file BuildComposablePipeline.java.

Here is the call graph for this function:

◆ postDownstreamCallHook()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.postDownstreamCallHook ( final PrintWriter  output,
final PlainMethod  pm 
)
protected

Called after the pipeline has routed the call to the downstream object, but before the calling function exits or returns a value.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 987 of file BuildComposablePipeline.java.

Here is the call graph for this function:

◆ postMethodEmissionHook()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.postMethodEmissionHook ( final PrintWriter  output)
protected

Called after the method wrappers have been generated, but before the closing parenthesis of the class is emitted.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 896 of file BuildComposablePipeline.java.

Here is the call graph for this function:

◆ preDownstreamCallHook()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.preDownstreamCallHook ( final PrintWriter  output,
final PlainMethod  pm 
)
protected

Called before the pipeline routes the call to the downstream object.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 977 of file BuildComposablePipeline.java.

◆ preMethodEmissionHook()

void com.jogamp.gluegen.opengl.BuildComposablePipeline.DebugPipeline.preMethodEmissionHook ( final PrintWriter  output)
protected

Called after the class headers have been generated, but before any method wrappers have been generated.

Reimplemented from com.jogamp.gluegen.opengl.BuildComposablePipeline.PipelineEmitter.

Definition at line 871 of file BuildComposablePipeline.java.


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