Interface GLBase
- All Known Subinterfaces:
GL
,GL2
,GL2ES1
,GL2ES2
,GL2ES3
,GL2GL3
,GL3
,GL3bc
,GL3ES3
,GL4
,GL4bc
,GL4ES3
,GLES1
,GLES2
,GLES3
- All Known Implementing Classes:
DebugGL2
,DebugGL3
,DebugGL3bc
,DebugGL4
,DebugGL4bc
,DebugGLES1
,DebugGLES2
,DebugGLES3
,TraceGL2
,TraceGL3
,TraceGL3bc
,TraceGL4
,TraceGL4bc
,TraceGLES1
,TraceGLES2
,TraceGLES3
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:
- WGL_ARB_pbuffer, WGL_ARB_pixel_format, and other
platform-specific pbuffer functionality; the availability of
pbuffers can be queried on Windows, X11 and Mac OS X platforms by
querying
isExtensionAvailable(java.lang.String)
with an argument of "GL_ARB_pbuffer" or "GL_ARB_pixel_format".
-
Method Summary
Modifier and TypeMethodDescriptionint
getBoundBuffer
(int target) int
getBoundFramebuffer
(int target) Return the framebuffer name bound to this context, seeGL.glBindFramebuffer(int, int)
.getBufferStorage
(int bufferName) Returns the GLContext associated which this GL object.int
Return the default draw framebuffer name.int
Returns the default color buffer within the current boundgetDefaultReadFramebuffer()
, i.e.int
Return the default read framebuffer name.Returns the downstream GL instance in case this is a wrapping pipeline, otherwisenull
.getExtension
(String extensionName) Returns an object providing access to the specified OpenGL extension.getGL()
Casts this object to the GL interface.getGL2()
Casts this object to the GL2 interface.Casts this object to the GL2ES1 interface.Casts this object to the GL2ES2 interface.Casts this object to the GL2ES3 interface.Casts this object to the GL2GL3 interface.getGL3()
Casts this object to the GL3 interface.getGL3bc()
Casts this object to the GL3bc interface.Casts this object to the GL3ES3 interface.getGL4()
Casts this object to the GL4 interface.getGL4bc()
Casts this object to the GL4bc interface.Casts this object to the GL4ES3 interface.getGLES1()
Casts this object to the GLES1 interface.getGLES2()
Casts this object to the GLES2 interface.getGLES3()
Casts this object to the GLES3 interface.Returns the GLProfile associated with this GL object.int
Returns the maximum number of FBO RENDERBUFFER samples iffull FBO is supported
, otherwise false.Returns an object through which platform-specific OpenGL extensions (EGL, GLX, WGL, etc.) may be accessed.Returns the implementing root instance, considering a wrapped pipelined hierarchy, seegetDownstreamGL()
.int
Return the current swap interval.void
glClearDepth
(double depth) Aliased entrypoint ofvoid (GLclampd depth);
andvoid (GLclampf depth);
.void
glDepthRange
(double zNear, double zFar) Aliased entrypoint ofvoid (GLclampd depth);
andvoid (GLclampf depth);
.boolean
Returnstrue
if basic FBO support is available, otherwisefalse
.boolean
Returnstrue
if full FBO support is available, otherwisefalse
.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
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
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
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
Indicates whether this GL object is compatible with the core OpenGL ES3.1 functionality.boolean
Indicates whether this GL object is compatible with the core OpenGL ES3.2 functionality.boolean
Indicates whether this GL object is compatible with the core OpenGL ES3 functionality.boolean
Returns true if the GL context supports non power of two (NPOT) textures, otherwise false.boolean
boolean
boolean
mapBuffer
(int target, int access) Returns theGLBufferStorage
instance as mapped via OpenGL's nativeglMapBuffer(..)
implementation.mapBufferRange
(int target, long offset, long length, int access) Returns theGLBufferStorage
instance as mapped via OpenGL's nativeglMapBufferRange(..)
implementation.void
setSwapInterval
(int interval) Set the swap interval of the current context and attached onscreenGLDrawable
.
-
Method Details
-
isGL
boolean isGL()Indicates whether this GL object conforms to any of the OpenGL profiles. -
isGL4bc
boolean isGL4bc()Indicates whether this GL object conforms to the OpenGL ≥ 4.0 compatibility profile. The GL4 compatibility profile includes the GL2, GL2ES1, GL2ES2, GL3, GL3bc and GL4 profile.- See Also:
-
isGL4
boolean isGL4()Indicates whether this GL object conforms to the OpenGL ≥ 4.0 core profile. The GL4 core profile includes the GL2ES2, and GL3 profile.- See Also:
-
isGL3bc
boolean isGL3bc()Indicates whether this GL object conforms to the OpenGL ≥ 3.1 compatibility profile. The GL3 compatibility profile includes the GL2, GL2ES1, GL2ES2 and GL3 profile.- See Also:
-
isGL3
boolean isGL3()Indicates whether this GL object conforms to the OpenGL ≥ 3.1 core profile. The GL3 core profile includes the GL2ES2 profile.- See Also:
-
isGL2
boolean isGL2()Indicates whether this GL object conforms to the OpenGL ≤ 3.0 profile. The GL2 profile includes the GL2ES1 and GL2ES2 profile.- See Also:
-
isGLES1
boolean isGLES1()Indicates whether this GL object conforms to the OpenGL ES ≥ 1.0 profile.- See Also:
-
isGLES2
boolean isGLES2()Indicates whether this GL object conforms to the OpenGL ES ≥ 2.0 profile.Remark: ES2 compatible desktop profiles are not included. To query whether core ES2 functionality is provided, use
isGLES2Compatible()
.- See Also:
-
isGLES3
boolean isGLES3()Indicates whether this GL object conforms to the OpenGL ES ≥ 3.0 profile.Remark: ES3 compatible desktop profiles are not included. To query whether core ES3 functionality is provided, use
isGLES3Compatible()
.- See Also:
-
isGLES
boolean isGLES()Indicates whether this GL object conforms to one of the OpenGL ES profiles, seeisGLES1()
,isGLES2()
andisGLES3()
.- See Also:
-
isGL2ES1
boolean isGL2ES1()Indicates whether this GL object conforms to a GL2ES1 compatible profile.- See Also:
-
isGL2ES2
boolean isGL2ES2()Indicates whether this GL object conforms to a GL2ES2 compatible profile.- See Also:
-
isGL2ES3
boolean isGL2ES3()Indicates whether this GL object conforms to a either a GL2GL3 or GL3ES3 compatible profile.- See Also:
-
isGL3ES3
boolean isGL3ES3()Indicates whether this GL object conforms to a GL3ES3 compatible profile.- See Also:
-
isGL4ES3
boolean isGL4ES3()Returns true if this GL object conforms to a GL4ES3 compatible profile, i.e. ifisGLES3Compatible()
returns true.Includes [ GL ≥ 4.3, GL ≥ 3.1 w/ GL_ARB_ES3_compatibility and GLES3 ]
- See Also:
-
isGL2GL3
boolean isGL2GL3()Indicates whether this GL object conforms to a GL2GL3 compatible profile.- See Also:
-
isGL4core
boolean isGL4core()Indicates whether this GL object uses a GL4 core profile.Includes [ GL4 ].
- See Also:
-
isGL3core
boolean isGL3core()Indicates whether this GL object uses a GL3 core profile.Includes [ GL4, GL3 ].
- See Also:
-
isGLcore
boolean isGLcore()Indicates whether this GL object uses a GL core profile.Includes [ GL4, GL3, GLES3, GL2ES2 ].
- See Also:
-
isGLES2Compatible
boolean isGLES2Compatible()Indicates whether this GL object is compatible with the core OpenGL ES2 functionality.- Returns:
- true if this context is an ES2 context or implements
the extension
GL_ARB_ES2_compatibility
, otherwise false - See Also:
-
isGLES3Compatible
boolean isGLES3Compatible()Indicates whether this GL object is compatible with the core OpenGL ES3 functionality.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 ]
- See Also:
-
isGLES31Compatible
boolean isGLES31Compatible()Indicates whether this GL object is compatible with the core OpenGL ES3.1 functionality.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 ]
- See Also:
-
isGLES32Compatible
boolean isGLES32Compatible()Indicates whether this GL object is compatible with the core OpenGL ES3.2 functionality.Return true if the underlying context is an ES3 context ≥ 3.2 or implements the extension
GL_ARB_ES3_2_compatibility
, otherwise false.Includes [ GL ≥ 4.5, GL ≥ 3.1 w/ GL_ARB_ES3_2_compatibility and GLES3 ≥ 3.2 ]
- See Also:
-
hasGLSL
boolean hasGLSL()Indicates whether this GL object supports GLSL.- See Also:
-
getDownstreamGL
Returns the downstream GL instance in case this is a wrapping pipeline, otherwisenull
.See
getRootGL()
for retrieving the implementing root instance.- Throws:
GLException
- if the downstream instance is not null and not a GL implementation- See Also:
-
getRootGL
Returns the implementing root instance, considering a wrapped pipelined hierarchy, seegetDownstreamGL()
.If this instance is not a wrapping pipeline, i.e. has no downstream instance, this instance is returned.
- Throws:
GLException
- if the root instance is not a GL implementation
-
getGL
Casts this object to the GL interface.- Throws:
GLException
- if this object is not a GL implementation
-
getGL4bc
Casts this object to the GL4bc interface.- Throws:
GLException
- if this object is not a GL4bc implementation
-
getGL4
Casts this object to the GL4 interface.- Throws:
GLException
- if this object is not a GL4 implementation
-
getGL3bc
Casts this object to the GL3bc interface.- Throws:
GLException
- if this object is not a GL3bc implementation
-
getGL3
Casts this object to the GL3 interface.- Throws:
GLException
- if this object is not a GL3 implementation
-
getGL2
Casts this object to the GL2 interface.- Throws:
GLException
- if this object is not a GL2 implementation
-
getGLES1
Casts this object to the GLES1 interface.- Throws:
GLException
- if this object is not a GLES1 implementation
-
getGLES2
Casts this object to the GLES2 interface.- Throws:
GLException
- if this object is not a GLES2 implementation
-
getGLES3
Casts this object to the GLES3 interface.- Throws:
GLException
- if this object is not a GLES3 implementation
-
getGL2ES1
Casts this object to the GL2ES1 interface.- Throws:
GLException
- if this object is not a GL2ES1 implementation
-
getGL2ES2
Casts this object to the GL2ES2 interface.- Throws:
GLException
- if this object is not a GL2ES2 implementation
-
getGL2ES3
Casts this object to the GL2ES3 interface.- Throws:
GLException
- if this object is not a GL2ES3 implementation
-
getGL3ES3
Casts this object to the GL3ES3 interface.- Throws:
GLException
- if this object is not a GL3ES3 implementation
-
getGL4ES3
Casts this object to the GL4ES3 interface.- Throws:
GLException
- if this object is not a GL4ES3 implementation
-
getGL2GL3
Casts this object to the GL2GL3 interface.- Throws:
GLException
- if this object is not a GL2GL3 implementation
-
getGLProfile
GLProfile getGLProfile()Returns the GLProfile associated with this GL object. -
getContext
GLContext getContext()Returns the GLContext associated which this GL object. -
isFunctionAvailable
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.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.
- Parameters:
glFunctionName
- the name of the OpenGL function (e.g., use "glBindRenderbufferEXT" or "glBindRenderbuffer" to check ifGL.glBindRenderbuffer(int,int)
is available).
-
isExtensionAvailable
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.- Parameters:
glExtensionName
- the name of the OpenGL extension (e.g., "GL_ARB_vertex_program").
-
hasBasicFBOSupport
boolean hasBasicFBOSupport()Returnstrue
if basic FBO support is available, otherwisefalse
.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
orGL_OES_framebuffer_object
.Basic FBO support may only include one color attachment and no multisampling, as well as limited internal formats for renderbuffer.
- See Also:
-
hasFullFBOSupport
boolean hasFullFBOSupport()Returnstrue
if full FBO support is available, otherwisefalse
.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 ofEXT_framebuffer_object
,EXT_framebuffer_multisample
,EXT_framebuffer_blit
,GL_EXT_packed_depth_stencil
.Full FBO support includes multiple color attachments and multisampling.
- See Also:
-
getMaxRenderbufferSamples
int getMaxRenderbufferSamples()Returns the maximum number of FBO RENDERBUFFER samples iffull FBO is supported
, otherwise false.- See Also:
-
isNPOTTextureAvailable
boolean isNPOTTextureAvailable()Returns true if the GL context supports non power of two (NPOT) textures, otherwise false.NPOT textures are supported in OpenGL >= 3, GLES2 or if the 'GL_ARB_texture_non_power_of_two' extension is available.
-
isTextureFormatBGRA8888Available
boolean isTextureFormatBGRA8888Available() -
setSwapInterval
Set the swap interval of the current context and attached onscreenGLDrawable
.offscreen
GLDrawable
are ignored andfalse
is returned.The
interval
semantics:- 0 disables the vertical synchronization
- ≥1 is the number of vertical refreshes before a swap buffer occurs
- <0 enables late swaps to occur without synchronization to the video frame, a.k.a EXT_swap_control_tear. If supported, the absolute value is the minimum number of video frames between buffer swaps. If not supported, the absolute value is being used, see above.
- Parameters:
interval
- see above- Throws:
GLException
- if the context is not current.- See Also:
-
getSwapInterval
int getSwapInterval()Return the current swap interval.If the context has not been made current at all, the default value
0
is returned.For a valid context w/ an
onscreen GLDrawable
the default value is1
, otherwise the default value is0
. -
getPlatformGLExtensions
Object getPlatformGLExtensions()Returns an object through which platform-specific OpenGL extensions (EGL, GLX, WGL, etc.) may be accessed. The data type of the returned object and its associated capabilities are undefined. Most applications will never need to call this method. It is highly recommended that any applications which do call this method perform all accesses on the returned object reflectively to guard themselves against changes to the implementation. -
getExtension
Returns an object providing access to the specified OpenGL extension. This is intended to provide a mechanism for vendors who wish to provide access to new OpenGL extensions without changing the public API of the core package. For example, a user may request access to extension "GL_VENDOR_foo" and receive back an object which implements a vendor-specified interface which can call the OpenGL extension functions corresponding to that extension. It is up to the vendor to specify both the extension name and Java API for accessing it, including which class or interface contains the functions.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.
-
glClearDepth
void glClearDepth(double depth) Aliased entrypoint ofvoid (GLclampd depth);
andvoid (GLclampf depth);
. -
glDepthRange
void glDepthRange(double zNear, double zFar) Aliased entrypoint ofvoid (GLclampd depth);
andvoid (GLclampf depth);
. -
getBoundBuffer
int getBoundBuffer(int target) - Parameters:
target
- a GL buffer (VBO) target as used inGL.glBindBuffer(int, int)
, ieGL.GL_ELEMENT_ARRAY_BUFFER
,GL.GL_ARRAY_BUFFER
, ..- Returns:
- the GL buffer name bound to a target via
GL.glBindBuffer(int, int)
or 0 if unbound. - See Also:
-
getBufferStorage
- Parameters:
bufferName
- a GL buffer name, generated with e.g.GL.glGenBuffers(int, int[], int)
and used inGL.glBindBuffer(int, int)
,GL.glBufferData(int, long, java.nio.Buffer, int)
orGL2.glNamedBufferDataEXT(int, long, java.nio.Buffer, int)
.- Returns:
- the size of the given GL buffer storage, see
GLBufferStorage
- See Also:
-
mapBuffer
Returns theGLBufferStorage
instance as mapped via OpenGL's nativeglMapBuffer(..)
implementation.Throws a
GLException
if GL-function constraints are not met.GL.glMapBuffer(int, int)
wrapper calls this method and returnsGLBufferStorage.getMappedBuffer()
.A zero
GLBufferStorage.getSize()
will avoid a native call and returns the unmappedGLBufferStorage
.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.- Parameters:
target
- denotes the buffer via it's bound targetaccess
- the mapping access mode- Throws:
GLException
- 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 zero
-
mapBufferRange
Returns theGLBufferStorage
instance as mapped via OpenGL's nativeglMapBufferRange(..)
implementation.Throws a
GLException
if GL-function constraints are not met.GL.glMapBufferRange(int, long, long, int)
wrapper calls this method and returnsGLBufferStorage.getMappedBuffer()
.A zero
GLBufferStorage.getSize()
will avoid a native call and returns the unmappedGLBufferStorage
.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.- Parameters:
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 mode- Throws:
GLException
- 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. offset
-
isVBOArrayBound
boolean isVBOArrayBound()- Returns:
- true if a VBO is bound to
GL.GL_ARRAY_BUFFER
viaGL.glBindBuffer(int, int)
, otherwise false
-
isVBOElementArrayBound
boolean isVBOElementArrayBound()- Returns:
- true if a VBO is bound to
GL.GL_ELEMENT_ARRAY_BUFFER
viaGL.glBindBuffer(int, int)
, otherwise false
-
getBoundFramebuffer
int getBoundFramebuffer(int target) Return the framebuffer name bound to this context, seeGL.glBindFramebuffer(int, int)
. -
getDefaultDrawFramebuffer
int getDefaultDrawFramebuffer()Return the default draw framebuffer name.May differ from it's default
zero
in case an framebuffer object (FBObject
) based drawable is being used. -
getDefaultReadFramebuffer
int getDefaultReadFramebuffer()Return the default read framebuffer name.May differ from it's default
zero
in case an framebuffer object (FBObject
) based drawable is being used. -
getDefaultReadBuffer
int getDefaultReadBuffer()Returns the default color buffer within the current boundgetDefaultReadFramebuffer()
, i.e. GL_READ_FRAMEBUFFER, which will be used as the source for pixel reading commands, likeglReadPixels
etc.For offscreen framebuffer objects this is
GL.GL_COLOR_ATTACHMENT0
, otherwise this isGL.GL_FRONT
for single buffer configurations andGL.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
orGL.GL_COLOR_ATTACHMENT0
+iNote-3: See
swapBuffersBeforeRead
for read-pixels and swap-buffers implications.
-