persist_image

declaration:

(introduced in 0.2.2)
function persist_image(vid); => bool

The VID will irreversibly be marked as persistent in the current context stack. The object will be transfered upwards on [push_video_context] operations, and be synched downwards on any [pop_video_context] call down to the current active level.

It can be actively deleted with [delete_image][expire_image], and deletion will then propagate downwards.

The primary purpose for this function is to allow some key resources (background image, network frameservers etc.) to be maintained and accessible even though stack manipulation has occurred.

caveats:

This adds severe restrictions to the object (thus can fail IF some of these constraints are already violated);

persistent objects are not allowed to be instanced, rendertargets or linked. They cannot have a frameset or be part of one.

[system_context_size] changes that would reduce the size of the next context from the current size will fail if there are any persistent objects in it.