NAME

image_framecyclemode - Enable/Disable time-triggered active frameset frame cycling.

SYNOPSIS

nil
image_framecyclemode( vid:dst )
image_framecyclemode( vid:dst, int:time_steps )

DESCRIPTION

Every video object with a textured backing store has an active frame defined, which usually refers to the backing store that is allocated during object creation or explicitly updated via image_sharestorage . This frame can also be picked from a larger set that is allocated via image_framesetsize and populated via set_image_as_frame . The active frame property can then be managed manually via image_activeframe or automatically via this function. If called without any time_steps argument, the feature will be disabled, otherwise the active frame will be cycled in a (n + 1) % count order at a rate of time_steps ticks on the logic clock.

EXAMPLE

function image_framecyclemode0()


      a = fill_surface(64, 64, 255, 0, 0);


      b = fill_surface(64, 64, 0, 255, 0);


      c = fill_surface(64, 64, 0, 0, 255);


      image_framesetsize(a, 3);


      set_image_as_frame(a, b, 1);


      set_image_as_frame(a, c, 2);


      image_framecyclemode(a, 1);
end

SEE ALSO:

image_framesetsize(3) image_activeframe(3) set_image_as_frame(3)