Experimental:ProgressiveUnload Class

The ProgressiveUnload class describes a specific instance of the COMP.progressiveUnload() method. Methods and members of this class are used to obtain progress information about the underway progressive unload operation, or modify it.

n = op('comp1')

# Check if comp1 is progressively unloading
n.progressiveUnloader.active

# Get the total number of frames since comp1 has been progressively unloading
n.progressiveUnloader.elapsedFrames

# Terminate comp1's progressive unloading
n.progressiveUnloader.kill()

Members

active → bool (Read Only):

Returns true if progressive unloading is underway

remainingNodes → float (Read Only):

Returns the remaining nodes to be unloaded.

nodesUnloaded → float (Read Only):

Returns the number of unloaded nodes.

lastFrameUnloadTime → float (Read Only):

Returns the unload time (in milliseconds) of the latest frame.

averageFrameUnloadTime → float (Read Only):

Returns the average unload time (in milliseconds) across all previous frames.

gpuMemUnloaded → float (Read Only):

Returns the total gpuMemory (in MB) that has been unloaded.

elapsedFrames → float (Read Only):

Returns the elapsed frames since progressive unloading started.

Methods

kill()→ None:

Terminate the progressive unloading operation.