VgaGames 3 - Video man-pages

[.. upper level ..]

VG3_image_clone()

Clone an image (or window) as a new image (copy).
SYNTAX
struct vg3_image * VG3_image_clone(struct vg3_window *wstruct, struct vg3_image *imgptr, struct vg3_image_attributes *imgattr, char **rmem, size_t *rsize)

FUNCTION PARAMETERS
wstruct Window-struct
imgptr Source image to clone, or NULL = clone window
imgattr Image-attributes for the new image, or NULL if no modification is wanted
rmem For returning cloned image in the BMP format (allocated), for save to file, or NULL
rsize For returning size in bytes in rmem, or NULL

RETURN VALUE
Returns a pointer to the created cloned image or NULL on failure.

ERRORS
On error VG3_errmsg() returns: EINVAL - error in argument ENOSYS - cannot create image ENOMEM - cannot get memory

DESCRIPTION
Clone an image (or window) as a new image and return pointer to it. The new image is a copy and must be unloaded separately. If the window is cloned, all window-attributes set with VG3_window_attributes() will be respected.

SEE ALSO
VG3_image_create() VG3_image_text() VG3_image_clone_reference() VG3_image_load()