maspack.render.GL

Class GLResourceBase

java.lang.Object

maspack.util.ReferenceCountedBase

maspack.render.GL.GLResourceBase

All Implemented Interfaces:

GLResource, ReferenceCounted

Direct Known Subclasses:

GL2ResourceBase, GL3ResourceBase, GLRenderBuffer, GLSelector, GLShaderProgram, GLTexture

public abstract class GLResourceBase
extends ReferenceCountedBase
implements GLResource

Resource used by GL

Field Summary

Fields inherited from class maspack.util.ReferenceCountedBase

traceHistorySize, traceReferences

Constructor Summary

Constructors

Constructor and Description
GLResourceBase()

Method Summary

Modifier and Type	Method and Description
GLResourceBase	acquire() Signal the resource that something is holding a reference to it.
abstract void	dispose(com.jogamp.opengl.GL gl) Discard data, regardless of existing references
boolean	disposeInvalid(com.jogamp.opengl.GL gl) Dispose an invalid resource
boolean	disposeUnreferenced(com.jogamp.opengl.GL gl) Dispose if object is unreferenced
abstract boolean	isDisposed() Returns true if resource has been disposed
boolean	isValid() Returns true if resource can be used (i.e.
boolean	releaseDispose(com.jogamp.opengl.GL gl) Decrement reference count and dispose if no longer referenced, returning true if disposed
boolean	releaseDisposeDeferred(com.jogamp.opengl.GL gl, GLDeferredDeleteQueue queue) Like releaseDispose(GL), but when the reference count reaches zero the actual GL delete is deferred: instead of disposing inline (on whatever thread happens to make the final release, possibly the background garbage collector), the resource is enqueued on queue to be disposed later on a render thread.

Methods inherited from class maspack.util.ReferenceCountedBase

acquireAndCount, getReferenceCount, release, releaseAndCount

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface maspack.util.ReferenceCounted

acquireAndCount, getReferenceCount, release, releaseAndCount

Constructor Detail

GLResourceBase

public GLResourceBase()

Method Detail

dispose

public abstract void dispose(com.jogamp.opengl.GL gl)

Description copied from interface: GLResource

Discard data, regardless of existing references

Specified by:

dispose in interface GLResource

releaseDispose

public boolean releaseDispose(com.jogamp.opengl.GL gl)

Description copied from interface: GLResource

Decrement reference count and dispose if no longer referenced, returning true if disposed

Specified by:

releaseDispose in interface GLResource

releaseDisposeDeferred

public boolean releaseDisposeDeferred(com.jogamp.opengl.GL gl,
                                      GLDeferredDeleteQueue queue)

Like releaseDispose(GL), but when the reference count reaches zero the actual GL delete is deferred: instead of disposing inline (on whatever thread happens to make the final release, possibly the background garbage collector), the resource is enqueued on queue to be disposed later on a render thread. Falls back to the inline releaseDispose(GL) when queue is null or deferred deletion is disabled.

Returns:

true if this call released the final reference (whether disposed inline or enqueued for deferred disposal)

isDisposed

public abstract boolean isDisposed()

Description copied from interface: GLResource

Returns true if resource has been disposed

Specified by:

isDisposed in interface GLResource

isValid

public boolean isValid()

Description copied from interface: GLResource

Returns true if resource can be used (i.e. hasn't been disposed)

Specified by:

isValid in interface GLResource

Returns:

true if the resource can be used

disposeInvalid

public boolean disposeInvalid(com.jogamp.opengl.GL gl)

Description copied from interface: GLResource

Dispose an invalid resource

Specified by:

disposeInvalid in interface GLResource

Returns:

false if still valid, true otherwise

disposeUnreferenced

public boolean disposeUnreferenced(com.jogamp.opengl.GL gl)

Description copied from interface: GLResource

Dispose if object is unreferenced

Specified by:

disposeUnreferenced in interface GLResource

Parameters:

gl - context

Returns:

true if disposed

acquire

public GLResourceBase acquire()

Description copied from interface: ReferenceCounted

Signal the resource that something is holding a reference to it.

Specified by:

acquire in interface GLResource

Specified by:

acquire in interface ReferenceCounted

Overrides:

acquire in class ReferenceCountedBase

Returns:

a reference to the acquired object for convenience.