iGround::release()

Description

Releases the API object pointer.

Syntax

void operator delete(void* voidPointer)

Remarks

Note that the release method is wrapped by operator delete in the C++ bindings, where API objects are provided wrapped in std::unique_ptr, and where it would be dangerous for the release method to be directly available. The release method should then only be used directly when working with C# or JNI bindings.

This method indicates to PathEngine that the API object is no longer required.

After this method is called, no further method calls should be made on this object, and the object pointer should not be passed in as a direct or indirect argument to any other API methods. The API object pointer is now invalid, and should be discarded.

PathEngine is then free to delete the API object, but will not actually do so until all other references to the object (including internal references) have also been released.

C# Mapping

void release();

Java Mapping

void release();