NAME

delete_image - Delete a video object and associated resources.

SYNOPSIS

nil
delete_image( vid )

This function deletes vid, any attached frameservers and linked images without the MASK_LIVING flag cleared.

1: Trying to delete a non-existing image is considered a terminal state transition. The valid_vid function can be used as a last resort to to determine if a number maps to a valid vid or not, but is in many cases a sign of bad design.
2: In a LWA build, deleting WORLDID is a terminal state object. On other platforms it results in the default rendertarget being dropped. This can be used to save memory in some cases where rendering goes strictly through manually defined rendertargets.
3: If the underlying object is in an asynchronous load state, the load operation will be completed first.

function delete_image0()
      valid = fill_surface(32, 32, 255, 0, 0, 0);
      delete_image(valid);
end

function delete_image0()
      delete_image(WORLDID);
end

function delete_image1()
      delete_image();
end

function delete_image2()
      delete_image(BADID);
end

function delete_image3()
      delete_image(-1);
end