NativeObject (jMonkeyEngine3)

java.lang.Object
- com.jme3.util.NativeObject

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AudioData, BufferObject, Filter, FrameBuffer, Image, Shader, Shader.ShaderSource, VertexBuffer
```
public abstract class NativeObject
extends java.lang.Object
implements java.lang.Cloneable
```
Describes a native object. An encapsulation of a certain object on the native side of the graphics or audio library. This class is used to track when OpenGL and OpenAL native objects are collected by the garbage collector, and then invoke the proper destructor on the OpenGL library to delete it from memory.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`handleRef` A reference to a "handle".
`protected int`	`id` The ID of the object, usually depends on its type.
`static int`	`INVALID_ID`
`protected NativeObjectManager`	`objectManager` The object manager to which this NativeObject is registered to.
`protected static int`	`OBJTYPE_AUDIOBUFFER`
`protected static int`	`OBJTYPE_AUDIOSTREAM`
`protected static int`	`OBJTYPE_BO`
`protected static int`	`OBJTYPE_FILTER`
`protected static int`	`OBJTYPE_FRAMEBUFFER`
`protected static int`	`OBJTYPE_SHADER`
`protected static int`	`OBJTYPE_SHADERSOURCE`
`protected static int`	`OBJTYPE_TEXTURE`
`protected static int`	`OBJTYPE_VERTEXBUFFER`
`protected boolean`	`updateNeeded` True if the data represented by this GLObject has been changed and needs to be updated before used.

Constructor Summary

Constructors
Modifier Constructor and Description

NativeObject()
Creates a new GLObject.

protected NativeObject(int id)
Protected constructor that doesn't allocate handle ref.

Constructors
Modifier	Constructor and Description
	`NativeObject()` Creates a new GLObject.
`protected`	`NativeObject(int id)` Protected constructor that doesn't allocate handle ref.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearUpdateNeeded()` Internal use only.
`protected NativeObject`	`clone()` This should create a deep clone.
`abstract NativeObject`	`createDestructableClone()` Creates a shallow clone of this GL Object.
`protected void`	`deleteNativeBuffers()` Deletes any associated native `buffers`.
`abstract void`	`deleteObject(java.lang.Object rendererObject)` Deletes the GL object from the GPU when it is no longer used.
`void`	`dispose()` Reclaims native resources used by this NativeObject.
`int`	`getId()`
`abstract long`	`getUniqueId()` Returns a unique ID for this NativeObject.
`<T> java.lang.ref.WeakReference<T>`	`getWeakRef()` Acquire a weak reference to this NativeObject.
`boolean`	`isUpdateNeeded()` Internal use only.
`abstract void`	`resetObject()` Called when the GL context is restarted to reset all IDs.
`void`	`setId(int id)` Sets the ID of the NativeObject.
`void`	`setUpdateNeeded()` Internal use only.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - INVALID_ID
```
public static final int INVALID_ID
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_VERTEXBUFFER
```
protected static final int OBJTYPE_VERTEXBUFFER
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_TEXTURE
```
protected static final int OBJTYPE_TEXTURE
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_FRAMEBUFFER
```
protected static final int OBJTYPE_FRAMEBUFFER
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_SHADER
```
protected static final int OBJTYPE_SHADER
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_SHADERSOURCE
```
protected static final int OBJTYPE_SHADERSOURCE
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_AUDIOBUFFER
```
protected static final int OBJTYPE_AUDIOBUFFER
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_AUDIOSTREAM
```
protected static final int OBJTYPE_AUDIOSTREAM
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_FILTER
```
protected static final int OBJTYPE_FILTER
```
    See Also:
    
    Constant Field Values
  - OBJTYPE_BO
```
protected static final int OBJTYPE_BO
```
    See Also:
    
    Constant Field Values
  - objectManager
```
protected NativeObjectManager objectManager
```
    The object manager to which this NativeObject is registered to.
  - id
```
protected int id
```
    The ID of the object, usually depends on its type. Typically returned from calls like glGenTextures, glGenBuffers, etc.
  - handleRef
```
protected java.lang.Object handleRef
```
    A reference to a "handle". By hard referencing a certain object, it's possible to find when a certain GLObject is no longer used, and to delete its instance from the graphics library.
  - updateNeeded
```
protected boolean updateNeeded
```
    True if the data represented by this GLObject has been changed and needs to be updated before used.
- Constructor Detail
  - NativeObject
```
public NativeObject()
```
    Creates a new GLObject. Should be called by the subclasses.
  - NativeObject
```
protected NativeObject(int id)
```
    Protected constructor that doesn't allocate handle ref. This is used in subclasses for the createDestructableClone().
    
    Parameters:
    
    id - the desired ID
- Method Detail
  - setId
```
public void setId(int id)
```
    Sets the ID of the NativeObject. This method is used in Renderer and must not be called by the user.
    
    Parameters:
    
    id - The ID to set
  - getId
```
public int getId()
```
    Returns:
    
    The ID of the object. Should not be used by user code in most cases.
  - setUpdateNeeded
```
public void setUpdateNeeded()
```
    Internal use only. Indicates that the object has changed and its state needs to be updated.
  - clearUpdateNeeded
```
public void clearUpdateNeeded()
```
    Internal use only. Indicates that the state changes were applied.
  - isUpdateNeeded
```
public boolean isUpdateNeeded()
```
    Internal use only. Check if setUpdateNeeded() was called before.
    
    Returns:
    
    true if an update is needed, otherwise false
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clone
```
protected NativeObject clone()
```
    This should create a deep clone. For a shallow clone, use createDestructableClone().
    
    Overrides:
    
    clone in class java.lang.Object
  - deleteNativeBuffers
```
protected void deleteNativeBuffers()
```
    Deletes any associated native buffers. This is necessary because it is unlikely that native buffers will be garbage collected naturally (due to how GC works), therefore the collection must be handled manually. Only implementations that manage native buffers need to override this method. Note that the behavior that occurs when a deleted native buffer is used is not defined, therefore this method is protected
  - resetObject
```
public abstract void resetObject()
```
    Called when the GL context is restarted to reset all IDs. Prevents "white textures" on display restart.
  - deleteObject
```
public abstract void deleteObject(java.lang.Object rendererObject)
```
    Deletes the GL object from the GPU when it is no longer used. Called automatically by the GL object manager.
    
    Parameters:
    
    rendererObject - The renderer to be used to delete the object
  - createDestructableClone
```
public abstract NativeObject createDestructableClone()
```
    Creates a shallow clone of this GL Object. The deleteObject method should be functional for this object.
    
    Returns:
    
    a new instance
  - getUniqueId
```
public abstract long getUniqueId()
```
    Returns a unique ID for this NativeObject. No other NativeObject shall have the same ID.
    
    Returns:
    
    unique ID for this NativeObject.
  - dispose
```
public void dispose()
```
    Reclaims native resources used by this NativeObject. It should be safe to call this method or even use the object after it has been reclaimed, unless NativeObjectManager.UNSAFE is set to true, in that case native buffers are also reclaimed which may introduce instability.
  - getWeakRef
```
public <T> java.lang.ref.WeakReference<T> getWeakRef()
```
    Acquire a weak reference to this NativeObject.
    
    Type Parameters:
    
    T - the type
    
    Returns:
    
    a weak reference (possibly a pre-existing one)

Class NativeObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_ID

OBJTYPE_VERTEXBUFFER

OBJTYPE_TEXTURE

OBJTYPE_FRAMEBUFFER

OBJTYPE_SHADER

OBJTYPE_SHADERSOURCE

OBJTYPE_AUDIOBUFFER

OBJTYPE_AUDIOSTREAM

OBJTYPE_FILTER

OBJTYPE_BO

objectManager

id

handleRef

updateNeeded

Constructor Detail

NativeObject

NativeObject

Method Detail

setId

getId

setUpdateNeeded

clearUpdateNeeded

isUpdateNeeded

toString

clone

deleteNativeBuffers

resetObject

deleteObject

createDestructableClone

getUniqueId

dispose

getWeakRef