image_framesetsize

declaration:

::lua
function image_framesetsize(vid, count, [mode]) => nil

Allocate an empty frameset and associate with vid.

The optional mode argument (defaults to FRAMESET_SPLIT) defines how the frameset should be managed with respect to rendering mode and texturing.

FRAMESET_SPLIT means that only the active frame will be assigned to the texture used for map_diffuse (TU0).

FRAMESET_MULTITEXTURE means that the entire frameset (assuming there's enough texture units available) will be mapped to a unit each, labeled as map_tu0, map_tu1, etc.

All video objects start with an empty frameset. If image_framesetsize is called with an existing vid, a non-negative count will be set. Index 0 refers to itself.

caveats:

count is only allowed to grow, never shrink. When the containing object is deleted, the delete call will cascade to the frameset (assuming MASK_LIVING hasn't been changed).

related functions:

[set_image_as_frame] [set_image_active_frame] [image_framecyclemode]