public interface GLBase
The base interface from which all GL profiles derive, providing checked conversion down to concrete profiles, access to the OpenGL context associated with the GL and extension/function availability queries as described below.
While the APIs for vendor extensions are unconditionally
exposed, the underlying functions may not be present. The method
isFunctionAvailable(java.lang.String)
should be used to query the
availability of any non-core function before it is used for the
first time; for example,
gl.isFunctionAvailable("glProgramStringARB")
. On
certain platforms (Windows in particular), the most "core"
functionality is only OpenGL 1.1, so in theory any routines first
exposed in OpenGL 1.2, 1.3, and 1.4, 1.5, or 2.0 as well as vendor
extensions should all be queried. Calling an unavailable function
will cause a GLException
to be raised.
isExtensionAvailable(java.lang.String)
may also be used to determine whether
a specific extension is available before calling the routines or
using the functionality it exposes: for example,
gl.isExtensionAvailable("GL_ARB_vertex_program");
.
However, in this case it is up to the end user to know which
routines or functionality are associated with which OpenGL
extensions. It may also be used to test for the availability of a
particular version of OpenGL: for example,
gl.isExtensionAvailable("GL_VERSION_1_5");
.
Exceptions to the window system extension naming rules:
isExtensionAvailable(java.lang.String)
with an argument of
"GL_ARB_pbuffer" or "GL_ARB_pixel_format".Modifier and Type | Method and Description |
---|---|
int |
getBoundBuffer(int target) |
int |
getBoundFramebuffer(int target)
Return the framebuffer name bound to this context,
see
GL.glBindFramebuffer(int, int) . |
GLBufferStorage |
getBufferStorage(int bufferName) |
GLContext |
getContext()
Returns the GLContext associated which this GL object.
|
int |
getDefaultDrawFramebuffer()
Return the default draw framebuffer name.
|
int |
getDefaultReadBuffer()
Returns the default color buffer within the current bound
getDefaultReadFramebuffer() , i.e. |
int |
getDefaultReadFramebuffer()
Return the default read framebuffer name.
|
GL |
getDownstreamGL()
Returns the downstream GL instance in case this is a wrapping pipeline, otherwise
null . |
Object |
getExtension(String extensionName)
Returns an object providing access to the specified OpenGL
extension.
|
GL |
getGL()
Casts this object to the GL interface.
|
GL2 |
getGL2()
Casts this object to the GL2 interface.
|
GL2ES1 |
getGL2ES1()
Casts this object to the GL2ES1 interface.
|
GL2ES2 |
getGL2ES2()
Casts this object to the GL2ES2 interface.
|
GL2ES3 |
getGL2ES3()
Casts this object to the GL2ES3 interface.
|
GL2GL3 |
getGL2GL3()
Casts this object to the GL2GL3 interface.
|
GL3 |
getGL3()
Casts this object to the GL3 interface.
|
GL3bc |
getGL3bc()
Casts this object to the GL3bc interface.
|
GL3ES3 |
getGL3ES3()
Casts this object to the GL3ES3 interface.
|
GL4 |
getGL4()
Casts this object to the GL4 interface.
|
GL4bc |
getGL4bc()
Casts this object to the GL4bc interface.
|
GL4ES3 |
getGL4ES3()
Casts this object to the GL4ES3 interface.
|
GLES1 |
getGLES1()
Casts this object to the GLES1 interface.
|
GLES2 |
getGLES2()
Casts this object to the GLES2 interface.
|
GLES3 |
getGLES3()
Casts this object to the GLES3 interface.
|
GLProfile |
getGLProfile()
Returns the GLProfile associated with this GL object.
|
int |
getMaxRenderbufferSamples()
Returns the maximum number of FBO RENDERBUFFER samples
if
full FBO is supported , otherwise false. |
Object |
getPlatformGLExtensions()
Returns an object through which platform-specific OpenGL extensions
(EGL, GLX, WGL, etc.) may be accessed.
|
GL |
getRootGL()
Returns the implementing root instance, considering a wrapped pipelined hierarchy, see
getDownstreamGL() . |
int |
getSwapInterval()
Provides a platform-independent way to get the swap
interval set by
setSwapInterval(int) . |
void |
glClearDepth(double depth)
Aliased entrypoint of
void glClearDepth(GLclampd depth); and void glClearDepthf(GLclampf depth); . |
void |
glDepthRange(double zNear,
double zFar)
Aliased entrypoint of
void glDepthRange(GLclampd depth); and void glDepthRangef(GLclampf depth); . |
boolean |
hasBasicFBOSupport()
Returns
true if basic FBO support is available, otherwise false . |
boolean |
hasFullFBOSupport()
Returns
true if full FBO support is available, otherwise false . |
boolean |
hasGLSL()
Indicates whether this GL object supports GLSL.
|
boolean |
isExtensionAvailable(String glExtensionName)
Returns true if the specified OpenGL extension can be
used successfully through this GL instance given the current host (OpenGL
client) and display (OpenGL server) configuration.
|
boolean |
isFunctionAvailable(String glFunctionName)
Returns true if the specified OpenGL core- or extension-function can be
used successfully through this GL instance given the current host (OpenGL
client) and display (OpenGL server) configuration.
|
boolean |
isGL()
Indicates whether this GL object conforms to any of the OpenGL profiles.
|
boolean |
isGL2()
Indicates whether this GL object conforms to the OpenGL ≤ 3.0 profile.
|
boolean |
isGL2ES1()
Indicates whether this GL object conforms to a GL2ES1 compatible profile.
|
boolean |
isGL2ES2()
Indicates whether this GL object conforms to a GL2ES2 compatible profile.
|
boolean |
isGL2ES3()
Indicates whether this GL object conforms to a either a GL2GL3 or GL3ES3 compatible profile.
|
boolean |
isGL2GL3()
Indicates whether this GL object conforms to a GL2GL3 compatible profile.
|
boolean |
isGL3()
Indicates whether this GL object conforms to the OpenGL ≥ 3.1 core profile.
|
boolean |
isGL3bc()
Indicates whether this GL object conforms to the OpenGL ≥ 3.1 compatibility profile.
|
boolean |
isGL3core()
Indicates whether this GL object uses a GL3 core profile.
|
boolean |
isGL3ES3()
Indicates whether this GL object conforms to a GL3ES3 compatible profile.
|
boolean |
isGL4()
Indicates whether this GL object conforms to the OpenGL ≥ 4.0 core profile.
|
boolean |
isGL4bc()
Indicates whether this GL object conforms to the OpenGL ≥ 4.0 compatibility profile.
|
boolean |
isGL4core()
Indicates whether this GL object uses a GL4 core profile.
|
boolean |
isGL4ES3()
Returns true if this GL object conforms to a GL4ES3 compatible profile, i.e.
|
boolean |
isGLcore()
Indicates whether this GL object uses a GL core profile.
|
boolean |
isGLES()
|
boolean |
isGLES1()
Indicates whether this GL object conforms to the OpenGL ES ≥ 1.0 profile.
|
boolean |
isGLES2()
Indicates whether this GL object conforms to the OpenGL ES ≥ 2.0 profile.
|
boolean |
isGLES2Compatible()
Indicates whether this GL object is compatible with the core OpenGL ES2 functionality.
|
boolean |
isGLES3()
Indicates whether this GL object conforms to the OpenGL ES ≥ 3.0 profile.
|
boolean |
isGLES31Compatible()
Indicates whether this GL object is compatible with the core OpenGL ES3.1 functionality.
|
boolean |
isGLES3Compatible()
Indicates whether this GL object is compatible with the core OpenGL ES3 functionality.
|
boolean |
isNPOTTextureAvailable()
Returns true if the GL context supports non power of two (NPOT) textures,
otherwise false.
|
boolean |
isTextureFormatBGRA8888Available() |
boolean |
isVBOArrayBound() |
boolean |
isVBOElementArrayBound() |
GLBufferStorage |
mapBuffer(int target,
int access)
Returns the
GLBufferStorage instance as mapped via OpenGL's native glMapBuffer(..) implementation. |
GLBufferStorage |
mapBufferRange(int target,
long offset,
long length,
int access)
Returns the
GLBufferStorage instance as mapped via OpenGL's native glMapBufferRange(..) implementation. |
void |
setSwapInterval(int interval)
Provides a platform-independent way to specify the minimum swap
interval for buffer swaps.
|
boolean isGL()
boolean isGL4bc()
GLContext.isGL4bc()
boolean isGL4()
GLContext.isGL4()
boolean isGL3bc()
GLContext.isGL3bc()
boolean isGL3()
GLContext.isGL3()
boolean isGL2()
GLContext.isGL2()
boolean isGLES1()
GLContext.isGLES1()
boolean isGLES2()
Remark: ES2 compatible desktop profiles are not included.
To query whether core ES2 functionality is provided, use isGLES2Compatible()
.
isGLES2Compatible()
,
GLContext.isGLES2()
boolean isGLES3()
Remark: ES3 compatible desktop profiles are not included.
To query whether core ES3 functionality is provided, use isGLES3Compatible()
.
isGLES3Compatible()
,
GLContext.isGLES3()
boolean isGLES()
isGLES1()
, isGLES2()
and isGLES3()
.GLContext.isGLES()
boolean isGL2ES1()
GLContext.isGL2ES1()
boolean isGL2ES2()
GLContext.isGL2ES2()
boolean isGL2ES3()
GLContext.isGL2ES3()
boolean isGL3ES3()
GLContext.isGL3ES3()
boolean isGL4ES3()
isGLES3Compatible()
returns true.
Includes [ GL ≥ 4.3, GL ≥ 3.1 w/ GL_ARB_ES3_compatibility and GLES3 ]
GLContext.isGL4ES3()
boolean isGL2GL3()
GLContext.isGL2GL3()
boolean isGL4core()
Includes [ GL4 ].
GLContext.isGL4core()
boolean isGL3core()
Includes [ GL4, GL3 ].
GLContext.isGL3core()
boolean isGLcore()
Includes [ GL4, GL3, GLES3, GL2ES2 ].
GLContext.isGLcore()
boolean isGLES2Compatible()
GL_ARB_ES2_compatibility
, otherwise falseGLContext.isGLES2Compatible()
boolean isGLES3Compatible()
Return true if the underlying context is an ES3 context or implements
the extension GL_ARB_ES3_compatibility
, otherwise false.
Includes [ GL ≥ 4.3, GL ≥ 3.1 w/ GL_ARB_ES3_compatibility and GLES3 ]
GLContext.isGLES3Compatible()
boolean isGLES31Compatible()
Return true if the underlying context is an ES3 context ≥ 3.1 or implements
the extension GL_ARB_ES3_1_compatibility
, otherwise false.
Includes [ GL ≥ 4.5, GL ≥ 3.1 w/ GL_ARB_ES3_1_compatibility and GLES3 ≥ 3.1 ]
GLContext.isGLES31Compatible()
boolean hasGLSL()
GLContext.hasGLSL()
GL getDownstreamGL() throws GLException
null
.
See getRootGL()
for retrieving the implementing root instance.
GLException
- if the downstream instance is not null and not a GL implementationgetRootGL()
GL getRootGL() throws GLException
getDownstreamGL()
.
If this instance is not a wrapping pipeline, i.e. has no downstream instance, this instance is returned.
GLException
- if the root instance is not a GL implementationGL getGL() throws GLException
GLException
- if this object is not a GL implementationGL4bc getGL4bc() throws GLException
GLException
- if this object is not a GL4bc implementationGL4 getGL4() throws GLException
GLException
- if this object is not a GL4 implementationGL3bc getGL3bc() throws GLException
GLException
- if this object is not a GL3bc implementationGL3 getGL3() throws GLException
GLException
- if this object is not a GL3 implementationGL2 getGL2() throws GLException
GLException
- if this object is not a GL2 implementationGLES1 getGLES1() throws GLException
GLException
- if this object is not a GLES1 implementationGLES2 getGLES2() throws GLException
GLException
- if this object is not a GLES2 implementationGLES3 getGLES3() throws GLException
GLException
- if this object is not a GLES3 implementationGL2ES1 getGL2ES1() throws GLException
GLException
- if this object is not a GL2ES1 implementationGL2ES2 getGL2ES2() throws GLException
GLException
- if this object is not a GL2ES2 implementationGL2ES3 getGL2ES3() throws GLException
GLException
- if this object is not a GL2ES3 implementationGL3ES3 getGL3ES3() throws GLException
GLException
- if this object is not a GL3ES3 implementationGL4ES3 getGL4ES3() throws GLException
GLException
- if this object is not a GL4ES3 implementationGL2GL3 getGL2GL3() throws GLException
GLException
- if this object is not a GL2GL3 implementationGLProfile getGLProfile()
GLContext getContext()
boolean isFunctionAvailable(String glFunctionName)
By "successfully" we mean that the function is both callable on the machine running the program and available on the current display.
In order to call a function successfully, the function must be both callable on the machine running the program and available on the display device that is rendering the output (note: on non-networked, single-display machines these two conditions are identical; on networked and/or multi-display machines this becomes more complicated). These conditions are met if the function is either part of the core OpenGL version supported by both the host and display, or it is an OpenGL extension function that both the host and display support.
A GL function is callable if it is successfully linked at runtime, hence the GLContext must be made current at least once.
glFunctionName
- the name of the OpenGL function (e.g., use
"glBindRenderbufferEXT" or "glBindRenderbuffer" to check if GL.glBindRenderbuffer(int,int)
is available).boolean isExtensionAvailable(String glExtensionName)
glExtensionName
- the name of the OpenGL extension (e.g.,
"GL_ARB_vertex_program").boolean hasBasicFBOSupport()
true
if basic FBO support is available, otherwise false
.
Basic FBO is supported if the context is either GL-ES >= 2.0, GL >= 3.0 [core, compat] or implements the extensions
GL_ARB_ES2_compatibility
, GL_ARB_framebuffer_object
, GL_EXT_framebuffer_object
or GL_OES_framebuffer_object
.
Basic FBO support may only include one color attachment and no multisampling, as well as limited internal formats for renderbuffer.
GLContext.hasBasicFBOSupport()
boolean hasFullFBOSupport()
true
if full FBO support is available, otherwise false
.
Full FBO is supported if the context is either GL >= core 3.0 [ES, core, compat] or implements the extensions
ARB_framebuffer_object
, or all of
EXT_framebuffer_object
, EXT_framebuffer_multisample
,
EXT_framebuffer_blit
, GL_EXT_packed_depth_stencil
.
Full FBO support includes multiple color attachments and multisampling.
GLContext.hasFullFBOSupport()
int getMaxRenderbufferSamples()
full FBO is supported
, otherwise false.boolean isNPOTTextureAvailable()
NPOT textures are supported in OpenGL >= 3, GLES2 or if the 'GL_ARB_texture_non_power_of_two' extension is available.
boolean isTextureFormatBGRA8888Available()
void setSwapInterval(int interval)
GLException
- if this context is not the currentgetSwapInterval()
int getSwapInterval()
setSwapInterval(int)
. setSwapInterval(int)
yet,
-1 is returned, indicating that the platforms default
is being used.setSwapInterval(int)
Object getPlatformGLExtensions()
Object getExtension(String extensionName)
Note: it is the intent to add new extensions as quickly as possible to the core GL API. Therefore it is unlikely that most vendors will use this extension mechanism, but it is being provided for completeness.
void glClearDepth(double depth)
void glClearDepth(GLclampd depth);
and void glClearDepthf(GLclampf depth);
.void glDepthRange(double zNear, double zFar)
void glDepthRange(GLclampd depth);
and void glDepthRangef(GLclampf depth);
.int getBoundBuffer(int target)
target
- a GL buffer (VBO) target as used in GL.glBindBuffer(int, int)
, ie GL.GL_ELEMENT_ARRAY_BUFFER
, GL.GL_ARRAY_BUFFER
, ..GL.glBindBuffer(int, int)
or 0 if unbound.getBufferStorage(int)
GLBufferStorage getBufferStorage(int bufferName)
bufferName
- a GL buffer name, generated with e.g. GL.glGenBuffers(int, int[], int)
and used in GL.glBindBuffer(int, int)
, GL.glBufferData(int, long, java.nio.Buffer, int)
or GL2.glNamedBufferDataEXT(int, long, java.nio.Buffer, int)
.GLBufferStorage
getBoundBuffer(int)
GLBufferStorage mapBuffer(int target, int access) throws GLException
GLBufferStorage
instance as mapped via OpenGL's native glMapBuffer(..)
implementation.
Throws a GLException
if GL-function constraints are not met.
GL.glMapBuffer(int, int)
wrapper calls this method and returns GLBufferStorage.getMappedBuffer()
.
A zero GLBufferStorage.getSize()
will avoid a native call and returns the unmapped GLBufferStorage
.
A null native mapping result indicating an error will
not cause a GLException but returns the unmapped GLBufferStorage
.
This allows the user to handle this case.
target
- denotes the buffer via it's bound targetaccess
- the mapping access modeGLException
- if buffer is not bound to targetGLException
- if buffer is not trackedGLException
- if buffer is already mappedGLException
- if buffer has invalid store size, i.e. less-than zeroGLBufferStorage mapBufferRange(int target, long offset, long length, int access) throws GLException
GLBufferStorage
instance as mapped via OpenGL's native glMapBufferRange(..)
implementation.
Throws a GLException
if GL-function constraints are not met.
GL.glMapBufferRange(int, long, long, int)
wrapper calls this method and returns GLBufferStorage.getMappedBuffer()
.
A zero GLBufferStorage.getSize()
will avoid a native call and returns the unmapped GLBufferStorage
.
A null native mapping result indicating an error will
not cause a GLException but returns the unmapped GLBufferStorage
.
This allows the user to handle this case.
target
- denotes the buffer via it's bound targetoffset
- offset of the mapped buffer's storagelength
- length of the mapped buffer's storageaccess
- the mapping access modeGLException
- if buffer is not bound to targetGLException
- if buffer is not trackedGLException
- if buffer is already mappedGLException
- if buffer has invalid store size, i.e. less-than zeroGLException
- if buffer mapping range does not fit, incl. offsetboolean isVBOArrayBound()
GL.GL_ARRAY_BUFFER
via GL.glBindBuffer(int, int)
, otherwise falseboolean isVBOElementArrayBound()
GL.GL_ELEMENT_ARRAY_BUFFER
via GL.glBindBuffer(int, int)
, otherwise falseint getBoundFramebuffer(int target)
GL.glBindFramebuffer(int, int)
.
int getDefaultDrawFramebuffer()
May differ from it's default zero
in case an framebuffer object (FBObject
) based drawable
is being used.
int getDefaultReadFramebuffer()
May differ from it's default zero
in case an framebuffer object (FBObject
) based drawable
is being used.
int getDefaultReadBuffer()
getDefaultReadFramebuffer()
, i.e. GL_READ_FRAMEBUFFER,
which will be used as the source for pixel reading commands,
like glReadPixels
etc.
For offscreen framebuffer objects this is GL.GL_COLOR_ATTACHMENT0
,
otherwise this is GL.GL_FRONT
for single buffer configurations
and GL.GL_BACK
for double buffer configurations.
Note-1: Neither ES1 nor ES2 supports selecting the read buffer via glReadBuffer
and GL.GL_BACK
is the default.
Note-2: ES3 only supports GL.GL_BACK
, GL.GL_NONE
or GL.GL_COLOR_ATTACHMENT0
+i
Note-3: See swapBuffersBeforeRead
for read-pixels and swap-buffers implications.
Copyright 2010 JogAmp Community.