Package panamagl.factory

Interface PanamaGLFactory

All Superinterfaces:

PlatformMatcher

All Known Implementing Classes:

APanamaGLFactory

public interface PanamaGLFactory
extends PlatformMatcher

A PanamaGLFactory generates components for a given platform (CPU, OS) and will ensure the appropriate bindings as well as OpenGL way of implementing a rendering technic are applied a target platform. Platforms are resolved automatically through

invalid @link

{@link PanamaGLFactory.select()

} which picks the first PanamaGLFactory in classpath that PlatformMatcher.matches(Platform) hence the executing computer. PanamaGL component initialization starts while initializing a new GLCanvas for adding to an existing UI. The canvas will initialize all subsequent required components in order and will only require a GLEventListener to perform the application OpenGL calls through the GL interface. The initialization hence looks like :

 
 GLEventAdapter listener = TeapotGLEventListener();
 PanamaGLFactory factory = PanamaGLFactory.select();
 GLCanvasSwing panel = new GLCanvasSwing();
 panel.setGLEventListener(listener);
 frame.add(panel);
 
 

Classes generated by the available factories are represented below :

Author:

Martin Pernollet

Method Summary

Modifier and Type	Method	Description
void	destroyContext()	Destroy the GLContext that has been initialized (and cached) by this factory.
ThreadRedirect	getThreadRedirect()
FBO	newFBO(int width, int height)	Initialize an FBO that can be used by a OffscreenRenderer to initialize GPU buffers for rendering offscreen.
GL	newGL()	Initialize a platform dependent GL
GLContext	newGLContext()	Initialize a platform dependent GLContext later allowing to invoke OpenGL.
OffscreenRenderer	newOffscreenRenderer(FBOReader reader)	Initialize an OffscreenRenderer that can be used by a GLCanvas to render OpenGL.
static PanamaGLFactory	select()	Returns the first factory that is is compatible with the current Platform.
static PanamaGLFactory	selectFor(Platform platform)
void	setThreadRedirect(ThreadRedirect threadRedirect)	If a thread redirection is defined and non null, it will be applied to the OffscreenRenderer generated by this factory while calling newOffscreenRenderer(FBOReader).

Methods inherited from interface panamagl.platform.PlatformMatcher

matches

Method Details

newGL

GL newGL()

Initialize a platform dependent GL

Returns:

newGLContext

GLContext newGLContext()

Initialize a platform dependent GLContext later allowing to invoke OpenGL. This method will both initialize the context and call its GLContext.init() method that load the related native libraries and OpenGL function pointers required to configure the context.

Returns:

newFBO

FBO newFBO(int width,
 int height)

Initialize an FBO that can be used by a OffscreenRenderer to initialize GPU buffers for rendering offscreen.

Parameters:

width -

height -

Returns:

newOffscreenRenderer

OffscreenRenderer newOffscreenRenderer(FBOReader reader)

Initialize an OffscreenRenderer that can be used by a GLCanvas to render OpenGL. The offscreen renderer will initialize GL, GLContext and FBO instances with this factory. If a ThreadRedirect has been set on this factory, it will be set to the offscreen renderer to customize the thread to which the opengl rendering is applied.

destroyContext

void destroyContext()

Destroy the GLContext that has been initialized (and cached) by this factory.

setThreadRedirect

void setThreadRedirect(ThreadRedirect threadRedirect)

If a thread redirection is defined and non null, it will be applied to the OffscreenRenderer generated by this factory while calling newOffscreenRenderer(FBOReader). If it is null, the OffscreenRenderer will keep its default thread redirection.

getThreadRedirect

ThreadRedirect getThreadRedirect()

select

static PanamaGLFactory select()

Returns the first factory that is is compatible with the current Platform.

selectFor

static PanamaGLFactory selectFor(Platform platform)