Function is_inside_bitmap

  • Allegro

    Check if inside bitmap

    Parameters

    • bmp: undefined | BITMAP

      BITMAP to check if point is inside

    • x: number

      x position of point

    • y: number

      y position of point

    • clip: number

      Bitmap clipping

    Returns boolean

    true if inside bitmap, otherwise false

    1.10.30

    Remarks

    Returns non-zero if point (x, y) lies inside the bitmap. If ‘clip’ is non-zero, the function compares the coordinates with the clipping rectangle, that is it returns non-zero if the point lies inside the clipping rectangle or if clipping is disabled for the bitmap. If ‘clip’ is zero, the function compares the coordinates with the actual dimensions of the bitmap.

Generated using TypeDoc