public class

FileA3D

extends Object
java.lang.Object
   ↳ android.renderscript.FileA3D

Class Overview

FileA3D allows users to load Renderscript objects from files or resources stored on disk. It could be used to load items such as 3D geometry data converted to a Renderscript format from content creation tools. Currently only meshes are supported in FileA3D. When successfully loaded, FileA3D will contain a list of index entries for all the objects stored inside it.

Summary

Nested Classes
enum FileA3D.EntryType Specifies what renderscript object type is contained within the FileA3D IndexEntry  
class FileA3D.IndexEntry IndexEntry contains information about one of the Renderscript objects inside the file's index. 
Public Methods
static FileA3D createFromAsset(RenderScript rs, AssetManager mgr, String path)
Creates a FileA3D object from an asset stored on disk
static FileA3D createFromFile(RenderScript rs, String path)
Creates a FileA3D object from a file stored on disk
static FileA3D createFromFile(RenderScript rs, File path)
Creates a FileA3D object from a file stored on disk
static FileA3D createFromResource(RenderScript rs, Resources res, int id)
Creates a FileA3D object from an application resource
synchronized void destroy()
destroy disconnects the object from the native object effectivly rendering this java object dead.
FileA3D.IndexEntry getIndexEntry(int index)
Returns an index entry from the list of all objects inside FileA3D
int getIndexEntryCount()
Returns the number of objects stored inside the a3d file
void setName(String name)
setName assigns a name to an object.
Protected Methods
void finalize()
Called before the object's memory is reclaimed by the VM.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static FileA3D createFromAsset (RenderScript rs, AssetManager mgr, String path)

Since: API Level 11

Creates a FileA3D object from an asset stored on disk

Parameters
rs Context to which the object will belong.
mgr asset manager used to load asset
path location of the file to load
Returns
  • a3d file containing renderscript objects

public static FileA3D createFromFile (RenderScript rs, String path)

Since: API Level 11

Creates a FileA3D object from a file stored on disk

Parameters
rs Context to which the object will belong.
path location of the file to load
Returns
  • a3d file containing renderscript objects

public static FileA3D createFromFile (RenderScript rs, File path)

Since: API Level 11

Creates a FileA3D object from a file stored on disk

Parameters
rs Context to which the object will belong.
path location of the file to load
Returns
  • a3d file containing renderscript objects

public static FileA3D createFromResource (RenderScript rs, Resources res, int id)

Since: API Level 11

Creates a FileA3D object from an application resource

Parameters
rs Context to which the object will belong.
res resource manager used for loading
id resource to create FileA3D from
Returns
  • a3d file containing renderscript objects

public synchronized void destroy ()

Since: API Level 11

destroy disconnects the object from the native object effectivly rendering this java object dead. The primary use is to force immediate cleanup of resources when its believed the GC will not respond quickly enough.

public FileA3D.IndexEntry getIndexEntry (int index)

Since: API Level 11

Returns an index entry from the list of all objects inside FileA3D

Parameters
index number of the entry from the list to return
Returns
  • entry in the a3d file described by the index

public int getIndexEntryCount ()

Since: API Level 11

Returns the number of objects stored inside the a3d file

Returns
  • the number of objects stored inside the a3d file

public void setName (String name)

Since: API Level 11

setName assigns a name to an object. This object can later be looked up by this name. This name will also be retained if the object is written to an A3D file.

Parameters
name The name to assign to the object.

Protected Methods

protected void finalize ()

Since: API Level 11

Called before the object's memory is reclaimed by the VM. This can only happen once the garbage collector has detected that the object is no longer reachable by any thread of the running application.

The method can be used to free system resources or perform other cleanup before the object is garbage collected. The default implementation of the method is empty, which is also expected by the VM, but subclasses can override finalize() as required. Uncaught exceptions which are thrown during the execution of this method cause it to terminate immediately but are otherwise ignored.

Note that the VM does guarantee that finalize() is called at most once for any object, but it doesn't guarantee when (if at all) finalize() will be called. For example, object B's finalize() can delay the execution of object A's finalize() method and therefore it can delay the reclamation of A's memory. To be safe, use a ReferenceQueue, because it provides more control over the way the VM deals with references during garbage collection.

Throws
Throwable