Image.imageSpotlight Method

Produces a spotlight effect within the circle that is defined by radius with center coordinates x and y.

Syntax

public int imageSpotlight(
    int x, 
    int y, 
    int radius, 
    int smoothing, 
    int intensity)

Run On

Client

Parameters

  • x
    Type: int
    The X coordinate of the center of the spotlight.
  • y
    Type: int
    The Y coordinate of the center of the spotlight.
  • radius
    Type: int
    The radius of the spotlight in pixels.
  • smoothing
    Type: int
    Reserved parameter. Use a value of zero.
  • intensity
    Type: int
    The intensity of the surrounding pixels. The possible values are between 0 and 100 (%).

Return Value

Type: int
0 indicates success; otherwise, failure.

Remarks

The pixels within the circle are unchanged, but the other pixels in the image are darkened by reducing their intensity.

See Also

Reference

Image Class