DESIGN (xvisual) functions


LIBRARY ROUTINE

xvw_getimage - returns the image associated with an object

LIBRARY CALL

int xvw_getimage(
   xvobject object,
   int	    subimage,
   int	    decor,
   kobject  image)

INPUT

OUTPUT

RETURN VALUE

TRUE (1) on success, FALSE (0) otherwise

DESCRIPTION

xvw_getimage provides a convenient way in which to create a Khoros 2.0 VIFF file from images that may be displayed using non-Khoros methods. Images captured using getimage may be displayed with putimage (see putimage(1)), or manipulated using editimage (see editimage(1)).

xvw_getimage may be used in several ways: (1) you may get a single window in its entirety from the screen, (2) you may get specified portion of the screen, regardless of the number of windows which it may include, (3) you may get a window by the window name or window id, (4) get the entire screen without prompting the user.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

Restrictions on data or input as applicable

MODIFICATION

none

FILES

$DESIGN/objects/library/xvisual/src/getimage.c

SEE ALSO

xvisual(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.