[Contents] [Index] [Help] [Retrace] [Browse <] [Browse >]


   NAME      
        PointInImage -- Tests whether an image "contains" a point. (V36)

   SYNOPSIS
        DoesContain = PointInImage( Point, image )
        D0                          D0     A0

        bool pointinimage( struct point, struct image * );

   FUNCTION
        Tests whether a point is properly contained in an image.
        The intention of this is to provide custom gadgets a means
        to delegate "image mask" processing to the image, where
        it belongs (superseding things like BOOLMASK).  After all,
        a rounded rect image with a drop shadow knows more about
        what points are inside it than anybody else should.

        For traditional Intuition Images, this routine checks if
        the point is in the image box (leftedge/rightedge/width/height).

   INPUTS
        Point   - Two words, X/Y packed into a long, with high word
                containing 'X'.  This is what you get if you pass
                a Point structure (not a pointer!) using common
                C language parameter conventions.
        image - a pointer to a standard or custom image data object.
            NOTE: If 'Image' is NULL, this function returns TRUE.

   RESULT
        DoesContain - Boolean result of the test.

   EXAMPLE


   NOTES


   BUGS
        Only applies to the first image, does not follow NextImage
        linked list.  This might be preferred.

   SEE ALSO