JOGL 2.3.2 · com.jogamp.opengl.GLBase

Method Summary

Modifier and Type	Method and Description
public int	Returns: the GL buffer name bound to a target via `GL#glBindBuffer(int, int)` or 0 if unbound. getBoundBuffer(int a GL buffer (VBO) target as used in `GL#glBindBuffer(int, int)`, ie `GL#GL_ELEMENT_ARRAY_BUFFER`, `GL#GL_ARRAY_BUFFER`, .. target)
public int	getBoundFramebuffer(int target) Return the framebuffer name bound to this context, see `GL#glBindFramebuffer(int, int)`.
public GLBufferStorage	Returns: the size of the given GL buffer storage, see `GLBufferStorage` getBufferStorage(int 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)`. bufferName)
public GLContext	getContext() Returns the GLContext associated which this GL object.
public int	getDefaultDrawFramebuffer() Return the default draw framebuffer name.
public int	getDefaultReadBuffer() Returns the default color buffer within the current bound `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.
public int	getDefaultReadFramebuffer() Return the default read framebuffer name.
public GL	getDownstreamGL() Returns the downstream GL instance in case this is a wrapping pipeline, otherwise `null`.
public Object	getExtension(String extensionName) Returns an object providing access to the specified OpenGL extension.
public GL	getGL() Casts this object to the GL interface.
public GL2	getGL2() Casts this object to the GL2 interface.
public GL2ES1	getGL2ES1() Casts this object to the GL2ES1 interface.
public GL2ES2	getGL2ES2() Casts this object to the GL2ES2 interface.
public GL2ES3	getGL2ES3() Casts this object to the GL2ES3 interface.
public GL2GL3	getGL2GL3() Casts this object to the GL2GL3 interface.
public GL3	getGL3() Casts this object to the GL3 interface.
public GL3bc	getGL3bc() Casts this object to the GL3bc interface.
public GL3ES3	getGL3ES3() Casts this object to the GL3ES3 interface.
public GL4	getGL4() Casts this object to the GL4 interface.
public GL4bc	getGL4bc() Casts this object to the GL4bc interface.
public GL4ES3	getGL4ES3() Casts this object to the GL4ES3 interface.
public GLES1	getGLES1() Casts this object to the GLES1 interface.
public GLES2	getGLES2() Casts this object to the GLES2 interface.
public GLES3	getGLES3() Casts this object to the GLES3 interface.
public GLProfile	getGLProfile() Returns the GLProfile associated with this GL object.
public int	getMaxRenderbufferSamples() Returns the maximum number of FBO RENDERBUFFER samples if `full FBO is supported`, otherwise false.
public Object	getPlatformGLExtensions() Returns an object through which platform-specific OpenGL extensions (EGL, GLX, WGL, etc.) may be accessed.
public GL	getRootGL() Returns the implementing root instance, considering a wrapped pipelined hierarchy, see `getDownstreamGL()`.
public int	getSwapInterval() Return the current swap interval.
public void	glClearDepth(double depth) Aliased entrypoint of `void {@native glClearDepth}(GLclampd depth);` and `void {@native glClearDepthf}(GLclampf depth);` .
public void	glDepthRange(double zNear, double zFar) Aliased entrypoint of `void {@native glDepthRange}(GLclampd depth);` and `void {@native glDepthRangef}(GLclampf depth);` .
public boolean	hasBasicFBOSupport() Returns `true` if basic FBO support is available, otherwise `false`.
public boolean	hasFullFBOSupport() Returns `true` if full FBO support is available, otherwise `false`.
public boolean	hasGLSL() Indicates whether this GL object supports GLSL.
public boolean	isExtensionAvailable(String the name of the OpenGL extension (e.g., "GL_ARB_vertex_program"). 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.
public boolean	isFunctionAvailable(String the name of the OpenGL function (e.g., use "glBindRenderbufferEXT" or "glBindRenderbuffer" to check if `GL#glBindRenderbuffer(int, int)` is available). 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.
public boolean	isGL() Indicates whether this GL object conforms to any of the OpenGL profiles.
public boolean	isGL2() Indicates whether this GL object conforms to the OpenGL ≤ 3.0 profile.
public boolean	isGL2ES1() Indicates whether this GL object conforms to a GL2ES1 compatible profile.
public boolean	isGL2ES2() Indicates whether this GL object conforms to a GL2ES2 compatible profile.
public boolean	isGL2ES3() Indicates whether this GL object conforms to a either a GL2GL3 or GL3ES3 compatible profile.
public boolean	isGL2GL3() Indicates whether this GL object conforms to a GL2GL3 compatible profile.
public boolean	isGL3() Indicates whether this GL object conforms to the OpenGL ≥ 3.1 core profile.
public boolean	isGL3bc() Indicates whether this GL object conforms to the OpenGL ≥ 3.1 compatibility profile.
public boolean	isGL3core() Indicates whether this GL object uses a GL3 core profile.
public boolean	isGL3ES3() Indicates whether this GL object conforms to a GL3ES3 compatible profile.
public boolean	isGL4() Indicates whether this GL object conforms to the OpenGL ≥ 4.0 core profile.
public boolean	isGL4bc() Indicates whether this GL object conforms to the OpenGL ≥ 4.0 compatibility profile.
public boolean	isGL4core() Indicates whether this GL object uses a GL4 core profile.
public boolean	isGL4ES3() Returns true if this GL object conforms to a GL4ES3 compatible profile, i.e. if `isGLES3Compatible()` returns true.
public boolean	isGLcore() Indicates whether this GL object uses a GL core profile.
public boolean	isGLES() Indicates whether this GL object conforms to one of the OpenGL ES profiles, see `isGLES1()`, `isGLES2()` and `isGLES3()`.
public boolean	isGLES1() Indicates whether this GL object conforms to the OpenGL ES ≥ 1.0 profile.
public boolean	isGLES2() Indicates whether this GL object conforms to the OpenGL ES ≥ 2.0 profile.
public boolean	Returns: true if this context is an ES2 context or implements the extension `GL_ARB_ES2_compatibility`, otherwise false isGLES2Compatible() Indicates whether this GL object is compatible with the core OpenGL ES2 functionality.
public boolean	isGLES3() Indicates whether this GL object conforms to the OpenGL ES ≥ 3.0 profile.
public boolean	isGLES31Compatible() Indicates whether this GL object is compatible with the core OpenGL ES3.1 functionality.
public boolean	isGLES32Compatible() Indicates whether this GL object is compatible with the core OpenGL ES3.2 functionality.
public boolean	isGLES3Compatible() Indicates whether this GL object is compatible with the core OpenGL ES3 functionality.
public boolean	isNPOTTextureAvailable() Returns true if the GL context supports non power of two (NPOT) textures, otherwise false.
public boolean	isTextureFormatBGRA8888Available()
public boolean	Returns: true if a VBO is bound to `GL#GL_ARRAY_BUFFER` via `GL#glBindBuffer(int, int)`, otherwise false isVBOArrayBound()
public boolean	Returns: true if a VBO is bound to `GL#GL_ELEMENT_ARRAY_BUFFER` via `GL#glBindBuffer(int, int)`, otherwise false isVBOElementArrayBound()
public GLBufferStorage	mapBuffer(int denotes the buffer via it's bound target target, int the mapping access mode access) Returns the `GLBufferStorage` instance as mapped via OpenGL's native `glMapBuffer(..)` implementation.
public GLBufferStorage	mapBufferRange(final int denotes the buffer via it's bound target target, final long offset of the mapped buffer's storage offset, final long length of the mapped buffer's storage length, final int the mapping access mode access) Returns the `GLBufferStorage` instance as mapped via OpenGL's native `glMapBufferRange(..)` implementation.
public void	Returns: true if the operation was successful, otherwise false setSwapInterval(int see above interval) Set the swap interval of the current context and attached onscreen `GLDrawable`.

Method Detail

getBoundBuffer	back to summary
public int getBoundBuffer(int target) Parameters target:int a GL buffer (VBO) target as used in `GL#glBindBuffer(int, int)`, ie `GL#GL_ELEMENT_ARRAY_BUFFER`, `GL#GL_ARRAY_BUFFER`, .. Returns:int the GL buffer name bound to a target via `GL#glBindBuffer(int, int)` or 0 if unbound. See Also `getBufferStorage(int)`

getBoundFramebuffer back to summary

getBoundFramebuffer	back to summary
public int getBoundFramebuffer(int target) Return the framebuffer name bound to this context, see `GL#glBindFramebuffer(int, int)`. Calls `GLContext#getBoundFramebuffer(int)`.

public int getBoundFramebuffer(int target)

Return the framebuffer name bound to this context, see GL#glBindFramebuffer(int, int).

Calls GLContext#getBoundFramebuffer(int).

getBufferStorage back to summary

getBufferStorage	back to summary
public GLBufferStorage getBufferStorage(int bufferName) Parameters bufferName:int 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)`. Returns:GLBufferStorage the size of the given GL buffer storage, see `GLBufferStorage` See Also `getBoundBuffer(int)`

public GLBufferStorage getBufferStorage(int bufferName)

Parameters

bufferName:int: 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).

Returns:GLBufferStorage

the size of the given GL buffer storage, see GLBufferStorage

See Also

getBoundBuffer(int)

getContext	back to summary
public GLContext getContext() Returns the GLContext associated which this GL object.

getDefaultDrawFramebuffer back to summary

getDefaultDrawFramebuffer	back to summary
public int getDefaultDrawFramebuffer() Return the default draw framebuffer name. May differ from it's default `zero` in case an framebuffer object (`com.jogamp.opengl.FBObject`) based drawable is being used. Calls `GLContext#getDefaultDrawFramebuffer()`.

public int getDefaultDrawFramebuffer()

Return the default draw framebuffer name.

May differ from it's default zero in case an framebuffer object (com.jogamp.opengl.FBObject) based drawable is being used.

Calls GLContext#getDefaultDrawFramebuffer().

getDefaultReadBuffer back to summary

getDefaultReadBuffer	back to summary
public int getDefaultReadBuffer() Returns the default color buffer within the current bound `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. Calls `GLContext#getDefaultReadBuffer()`.

public int getDefaultReadBuffer()

Returns the default color buffer within the current bound 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.

Calls GLContext#getDefaultReadBuffer().

getDefaultReadFramebuffer back to summary

getDefaultReadFramebuffer	back to summary
public int getDefaultReadFramebuffer() Return the default read framebuffer name. May differ from it's default `zero` in case an framebuffer object (`com.jogamp.opengl.FBObject`) based drawable is being used. Calls `GLContext#getDefaultReadFramebuffer()`.

public int getDefaultReadFramebuffer()

Return the default read framebuffer name.

May differ from it's default zero in case an framebuffer object (com.jogamp.opengl.FBObject) based drawable is being used.

Calls GLContext#getDefaultReadFramebuffer().

getDownstreamGL back to summary

getDownstreamGL	back to summary
public GL getDownstreamGL() throws GLException Returns the downstream GL instance in case this is a wrapping pipeline, otherwise `null`. See `getRootGL()` for retrieving the implementing root instance. Exceptions GLException: if the downstream instance is not null and not a GL implementation See Also `getRootGL()`

public GL getDownstreamGL() throws GLException

Returns the downstream GL instance in case this is a wrapping pipeline, otherwise null.

See getRootGL() for retrieving the implementing root instance.

Exceptions

GLException:: if the downstream instance is not null and not a GL implementation

See Also

getRootGL()

getExtension	back to summary
public Object getExtension(String extensionName) 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.

getExtension

back to summary

public Object getExtension(String extensionName)

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.

getGL	back to summary
public GL getGL() throws GLException Casts this object to the GL interface. Exceptions GLException: if this object is not a GL implementation

getGL

back to summary

public GL getGL() throws GLException

Casts this object to the GL interface.

Exceptions

GLException:: if this object is not a GL implementation

getGL2	back to summary
public GL2 getGL2() throws GLException Casts this object to the GL2 interface. Exceptions GLException: if this object is not a GL2 implementation

getGL2

back to summary

public GL2 getGL2() throws GLException

Casts this object to the GL2 interface.

Exceptions

GLException:: if this object is not a GL2 implementation

getGL2ES1	back to summary
public GL2ES1 getGL2ES1() throws GLException Casts this object to the GL2ES1 interface. Exceptions GLException: if this object is not a GL2ES1 implementation

getGL2ES1

back to summary

public GL2ES1 getGL2ES1() throws GLException

Casts this object to the GL2ES1 interface.

Exceptions

GLException:: if this object is not a GL2ES1 implementation

getGL2ES2	back to summary
public GL2ES2 getGL2ES2() throws GLException Casts this object to the GL2ES2 interface. Exceptions GLException: if this object is not a GL2ES2 implementation

getGL2ES2

back to summary

public GL2ES2 getGL2ES2() throws GLException

Casts this object to the GL2ES2 interface.

Exceptions

GLException:: if this object is not a GL2ES2 implementation

getGL2ES3	back to summary
public GL2ES3 getGL2ES3() throws GLException Casts this object to the GL2ES3 interface. Exceptions GLException: if this object is not a GL2ES3 implementation

getGL2ES3

back to summary

public GL2ES3 getGL2ES3() throws GLException

Casts this object to the GL2ES3 interface.

Exceptions

GLException:: if this object is not a GL2ES3 implementation

getGL2GL3	back to summary
public GL2GL3 getGL2GL3() throws GLException Casts this object to the GL2GL3 interface. Exceptions GLException: if this object is not a GL2GL3 implementation

getGL2GL3

back to summary

public GL2GL3 getGL2GL3() throws GLException

Casts this object to the GL2GL3 interface.

Exceptions

GLException:: if this object is not a GL2GL3 implementation

getGL3	back to summary
public GL3 getGL3() throws GLException Casts this object to the GL3 interface. Exceptions GLException: if this object is not a GL3 implementation

getGL3

back to summary

public GL3 getGL3() throws GLException

Casts this object to the GL3 interface.

Exceptions

GLException:: if this object is not a GL3 implementation

getGL3bc	back to summary
public GL3bc getGL3bc() throws GLException Casts this object to the GL3bc interface. Exceptions GLException: if this object is not a GL3bc implementation

getGL3bc

back to summary

public GL3bc getGL3bc() throws GLException

Casts this object to the GL3bc interface.

Exceptions

GLException:: if this object is not a GL3bc implementation

getGL3ES3	back to summary
public GL3ES3 getGL3ES3() throws GLException Casts this object to the GL3ES3 interface. Exceptions GLException: if this object is not a GL3ES3 implementation

getGL3ES3

back to summary

public GL3ES3 getGL3ES3() throws GLException

Casts this object to the GL3ES3 interface.

Exceptions

GLException:: if this object is not a GL3ES3 implementation

getGL4	back to summary
public GL4 getGL4() throws GLException Casts this object to the GL4 interface. Exceptions GLException: if this object is not a GL4 implementation

getGL4

back to summary

public GL4 getGL4() throws GLException

Casts this object to the GL4 interface.

Exceptions

GLException:: if this object is not a GL4 implementation

getGL4bc	back to summary
public GL4bc getGL4bc() throws GLException Casts this object to the GL4bc interface. Exceptions GLException: if this object is not a GL4bc implementation

getGL4bc

back to summary

public GL4bc getGL4bc() throws GLException

Casts this object to the GL4bc interface.

Exceptions

GLException:: if this object is not a GL4bc implementation

getGL4ES3	back to summary
public GL4ES3 getGL4ES3() throws GLException Casts this object to the GL4ES3 interface. Exceptions GLException: if this object is not a GL4ES3 implementation

getGL4ES3

back to summary

public GL4ES3 getGL4ES3() throws GLException

Casts this object to the GL4ES3 interface.

Exceptions

GLException:: if this object is not a GL4ES3 implementation

getGLES1	back to summary
public GLES1 getGLES1() throws GLException Casts this object to the GLES1 interface. Exceptions GLException: if this object is not a GLES1 implementation

getGLES1

back to summary

public GLES1 getGLES1() throws GLException

Casts this object to the GLES1 interface.

Exceptions

GLException:: if this object is not a GLES1 implementation

getGLES2	back to summary
public GLES2 getGLES2() throws GLException Casts this object to the GLES2 interface. Exceptions GLException: if this object is not a GLES2 implementation

getGLES2

back to summary

public GLES2 getGLES2() throws GLException

Casts this object to the GLES2 interface.

Exceptions

GLException:: if this object is not a GLES2 implementation

getGLES3	back to summary
public GLES3 getGLES3() throws GLException Casts this object to the GLES3 interface. Exceptions GLException: if this object is not a GLES3 implementation

getGLES3

back to summary

public GLES3 getGLES3() throws GLException

Casts this object to the GLES3 interface.

Exceptions

GLException:: if this object is not a GLES3 implementation

getGLProfile	back to summary
public GLProfile getGLProfile() Returns the GLProfile associated with this GL object.

getMaxRenderbufferSamples back to summary

getMaxRenderbufferSamples	back to summary
public int getMaxRenderbufferSamples() Returns the maximum number of FBO RENDERBUFFER samples if `full FBO is supported`, otherwise false. See Also `GLContext#getMaxRenderbufferSamples()`

public int getMaxRenderbufferSamples()

Returns the maximum number of FBO RENDERBUFFER samples if full FBO is supported, otherwise false.

See Also: GLContext#getMaxRenderbufferSamples()

getPlatformGLExtensions	back to summary
public 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.

getPlatformGLExtensions

back to summary

public 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.

getRootGL back to summary

getRootGL	back to summary
public GL getRootGL() throws GLException Returns the implementing root instance, considering a wrapped pipelined hierarchy, see `getDownstreamGL()`. If this instance is not a wrapping pipeline, i.e. has no downstream instance, this instance is returned. Exceptions GLException: if the root instance is not a GL implementation

public GL getRootGL() throws GLException

Returns the implementing root instance, considering a wrapped pipelined hierarchy, see getDownstreamGL().

If this instance is not a wrapping pipeline, i.e. has no downstream instance, this instance is returned.

Exceptions

GLException:: if the root instance is not a GL implementation

getSwapInterval back to summary

getSwapInterval	back to summary
public 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 is `1`, otherwise the default value is `0`. See Also `GLContext#getSwapInterval()`, `setSwapInterval(int)`

public 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 is 1, otherwise the default value is 0.

See Also: GLContext#getSwapInterval(), setSwapInterval(int)

glClearDepth	back to summary
public void glClearDepth(double depth) Aliased entrypoint of `void {@native glClearDepth}(GLclampd depth);` and `void {@native glClearDepthf}(GLclampf depth);` .

glDepthRange	back to summary
public void glDepthRange(double zNear, double zFar) Aliased entrypoint of `void {@native glDepthRange}(GLclampd depth);` and `void {@native glDepthRangef}(GLclampf depth);` .

hasBasicFBOSupport back to summary

hasBasicFBOSupport	back to summary
public boolean hasBasicFBOSupport() Returns `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. See Also `GLContext#hasBasicFBOSupport()`

public boolean hasBasicFBOSupport()

Returns 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.

See Also: GLContext#hasBasicFBOSupport()

hasFullFBOSupport back to summary

hasFullFBOSupport	back to summary
public boolean hasFullFBOSupport() Returns `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. See Also `GLContext#hasFullFBOSupport()`

public boolean hasFullFBOSupport()

Returns 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.

See Also: GLContext#hasFullFBOSupport()

hasGLSL back to summary

hasGLSL	back to summary
public boolean hasGLSL() Indicates whether this GL object supports GLSL. See Also `GLContext#hasGLSL()`

public boolean hasGLSL()

Indicates whether this GL object supports GLSL.

See Also: GLContext#hasGLSL()

isExtensionAvailable	back to summary
public 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. Parameters glExtensionName:String the name of the OpenGL extension (e.g., "GL_ARB_vertex_program").

isExtensionAvailable

back to summary

public 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.

Parameters

glExtensionName:String: the name of the OpenGL extension (e.g., "GL_ARB_vertex_program").

isFunctionAvailable back to summary

isFunctionAvailable	back to summary
public 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. 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:String the name of the OpenGL function (e.g., use "glBindRenderbufferEXT" or "glBindRenderbuffer" to check if `GL#glBindRenderbuffer(int, int)` is available).

public 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.

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:String: the name of the OpenGL function (e.g., use "glBindRenderbufferEXT" or "glBindRenderbuffer" to check if GL#glBindRenderbuffer(int, int) is available).

isGL	back to summary
public boolean isGL() Indicates whether this GL object conforms to any of the OpenGL profiles.

isGL2 back to summary

isGL2	back to summary
public 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 `GLContext#isGL2()`

public 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: GLContext#isGL2()

isGL2ES1 back to summary

isGL2ES1	back to summary
public boolean isGL2ES1() Indicates whether this GL object conforms to a GL2ES1 compatible profile. See Also `GLContext#isGL2ES1()`

public boolean isGL2ES1()

Indicates whether this GL object conforms to a GL2ES1 compatible profile.

See Also: GLContext#isGL2ES1()

isGL2ES2 back to summary

isGL2ES2	back to summary
public boolean isGL2ES2() Indicates whether this GL object conforms to a GL2ES2 compatible profile. See Also `GLContext#isGL2ES2()`

public boolean isGL2ES2()

Indicates whether this GL object conforms to a GL2ES2 compatible profile.

See Also: GLContext#isGL2ES2()

isGL2ES3 back to summary

isGL2ES3	back to summary
public boolean isGL2ES3() Indicates whether this GL object conforms to a either a GL2GL3 or GL3ES3 compatible profile. See Also `GLContext#isGL2ES3()`

public boolean isGL2ES3()

Indicates whether this GL object conforms to a either a GL2GL3 or GL3ES3 compatible profile.

See Also: GLContext#isGL2ES3()

isGL2GL3 back to summary

isGL2GL3	back to summary
public boolean isGL2GL3() Indicates whether this GL object conforms to a GL2GL3 compatible profile. See Also `GLContext#isGL2GL3()`

public boolean isGL2GL3()

Indicates whether this GL object conforms to a GL2GL3 compatible profile.

See Also: GLContext#isGL2GL3()

isGL3 back to summary

isGL3	back to summary
public 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 `GLContext#isGL3()`

public 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: GLContext#isGL3()

isGL3bc back to summary

isGL3bc	back to summary
public 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 `GLContext#isGL3bc()`

public 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: GLContext#isGL3bc()

isGL3core back to summary

isGL3core	back to summary
public boolean isGL3core() Indicates whether this GL object uses a GL3 core profile. Includes [ GL4, GL3 ]. See Also `GLContext#isGL3core()`

public boolean isGL3core()

Indicates whether this GL object uses a GL3 core profile.

Includes [ GL4, GL3 ].

See Also: GLContext#isGL3core()

isGL3ES3 back to summary

isGL3ES3	back to summary
public boolean isGL3ES3() Indicates whether this GL object conforms to a GL3ES3 compatible profile. See Also `GLContext#isGL3ES3()`

public boolean isGL3ES3()

Indicates whether this GL object conforms to a GL3ES3 compatible profile.

See Also: GLContext#isGL3ES3()

isGL4 back to summary

isGL4	back to summary
public 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 `GLContext#isGL4()`

public 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: GLContext#isGL4()

isGL4bc back to summary

isGL4bc	back to summary
public 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 `GLContext#isGL4bc()`

public 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: GLContext#isGL4bc()

isGL4core back to summary

isGL4core	back to summary
public boolean isGL4core() Indicates whether this GL object uses a GL4 core profile. Includes [ GL4 ]. See Also `GLContext#isGL4core()`

public boolean isGL4core()

Indicates whether this GL object uses a GL4 core profile.

Includes [ GL4 ].

See Also: GLContext#isGL4core()

isGL4ES3 back to summary

public boolean isGL4ES3()

Returns true if this GL object conforms to a GL4ES3 compatible profile, i.e. if isGLES3Compatible() returns true.

Includes [ GL ≥ 4.3, GL ≥ 3.1 w/ GL_ARB_ES3_compatibility and GLES3 ]

See Also: GLContext#isGL4ES3()

isGLcore back to summary

public boolean isGLcore()

Indicates whether this GL object uses a GL core profile.

Includes [ GL4, GL3, GLES3, GL2ES2 ].

See Also: GLContext#isGLcore()

isGLES back to summary

public boolean isGLES()

Indicates whether this GL object conforms to one of the OpenGL ES profiles, see isGLES1(), isGLES2() and isGLES3().

See Also: GLContext#isGLES()

isGLES1 back to summary

public boolean isGLES1()

Indicates whether this GL object conforms to the OpenGL ES ≥ 1.0 profile.

See Also: GLContext#isGLES1()

isGLES2 back to summary

public 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: isGLES2Compatible(), GLContext#isGLES2()

isGLES2Compatible back to summary

public boolean isGLES2Compatible()

Indicates whether this GL object is compatible with the core OpenGL ES2 functionality.

Returns:boolean: true if this context is an ES2 context or implements the extension GL_ARB_ES2_compatibility, otherwise false
See Also: GLContext#isGLES2Compatible()

isGLES3 back to summary

public 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: isGLES3Compatible(), GLContext#isGLES3()

isGLES31Compatible back to summary

public 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: GLContext#isGLES31Compatible()

isGLES32Compatible back to summary

public 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: GLContext#isGLES32Compatible()

isGLES3Compatible back to summary

public 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: GLContext#isGLES3Compatible()

isNPOTTextureAvailable

back to summary

public 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	back to summary
public boolean isTextureFormatBGRA8888Available()

isVBOArrayBound	back to summary
public boolean isVBOArrayBound() Returns:boolean true if a VBO is bound to `GL#GL_ARRAY_BUFFER` via `GL#glBindBuffer(int, int)`, otherwise false

isVBOElementArrayBound	back to summary
public boolean isVBOElementArrayBound() Returns:boolean true if a VBO is bound to `GL#GL_ELEMENT_ARRAY_BUFFER` via `GL#glBindBuffer(int, int)`, otherwise false

mapBuffer back to summary

public GLBufferStorage mapBuffer(int target, int access) throws GLException

Returns the 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.

Parameters

target:int: denotes the buffer via it's bound target
access:int: the mapping access mode

Exceptions

GLException:

if buffer is not bound to target
if buffer is not tracked
if buffer is already mapped
if buffer has invalid store size, i.e. less-than zero

mapBufferRange back to summary

public GLBufferStorage mapBufferRange(final int target, final long offset, final long length, final int access) throws GLException

Returns the 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.

Parameters

target:int: denotes the buffer via it's bound target
offset:long: offset of the mapped buffer's storage
length:long: length of the mapped buffer's storage
access:int: the mapping access mode

Exceptions

GLException:

if buffer is not bound to target
if buffer is not tracked
if buffer is already mapped
if buffer has invalid store size, i.e. less-than zero
if buffer mapping range does not fit, incl. offset

setSwapInterval back to summary

public void setSwapInterval(int interval) throws GLException

Set the swap interval of the current context and attached onscreen GLDrawable.

offscreen GLDrawable are ignored and false 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:int: see above

Returns:void

true if the operation was successful, otherwise false

Exceptions

GLException:: if the context is not current.

public Interface GLBase

Method Summary

Method Detail