Outline

Outline

Outline()

Constructs an empty Outline. Call one of the setter methods to make the outline valid for use with a View.

Outline

Outline(src: Outline)

Constructs an Outline with a copy of the data in src.

canClip

fun canClip(): Boolean

Returns whether the outline can be used to clip a View.

As of API 33, all Outline shapes support clipping. Prior to API 33, only Outlines that could be represented as a rectangle, circle, or round rect supported clipping.

getAlpha

fun getAlpha(): Float

Returns the alpha represented by the Outline.

getRadius

fun getRadius(): Float

Returns the rounded rect radius, if set, or a value less than 0 if a path has been set via setPath(android.graphics.Path). A return value of 0 indicates a non-rounded rect.

getRect

fun getRect(outRect: Rect): Boolean

Populates outBounds with the outline bounds, if set, and returns true. If no outline bounds are set, or if a path has been set via setPath(android.graphics.Path), returns false.

isEmpty

fun isEmpty(): Boolean

Returns whether the Outline is empty.

Outlines are empty when constructed, or if setEmpty() is called, until a setter method is called

offset

fun offset(
    dx: Int, 
    dy: Int
): Unit

Offsets the Outline by (dx,dy). Offsetting is cumulative, so additional calls to offset() will add to previous offset values. Offset only applies to the current geometry (setRect(), setPath(), etc.); setting new geometry resets any existing offset.

set

fun set(src: Outline): Unit

Replace the contents of this Outline with the contents of src.

setAlpha

fun setAlpha(alpha: Float): Unit

Sets the alpha represented by the Outline - the degree to which the producer is guaranteed to be opaque over the Outline's shape.

An alpha value of 0.0f either represents completely transparent content, or content that isn't guaranteed to fill the shape it publishes.

Content producing a fully opaque (alpha = 1.0f) outline is assumed by the drawing system to fully cover content beneath it, meaning content beneath may be optimized away.

setConvexPath

fun setConvexPath(convexPath: Path): Unit

Deprecated: As of android.os.Build.VERSION_CODES#Q, the restriction that the path must be convex is removed. However, the API is misnamed until android.os.Build.VERSION_CODES#R, when setPath is introduced. Use setPath instead.

Sets the Outline to a convex path.

setEmpty

fun setEmpty(): Unit

Sets the outline to be empty.

setOval

fun setOval(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Sets the outline to the oval defined by input rect.

setOval

fun setOval(rect: Rect): Unit

Convenience for setOval(int,int,int,int)

setPath

fun setPath(path: Path): Unit

Sets the Outline to a path.

setRect

fun setRect(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int
): Unit

Sets the Outline to the rect defined by the input coordinates.

setRect

fun setRect(rect: Rect): Unit

Convenience for setRect(int,int,int,int)

setRoundRect

fun setRoundRect(
    left: Int, 
    top: Int, 
    right: Int, 
    bottom: Int, 
    radius: Float
): Unit

Sets the Outline to the rounded rect defined by the input coordinates and corner radius.

Passing a zero radius is equivalent to calling setRect(int,int,int,int)

setRoundRect

fun setRoundRect(
    rect: Rect, 
    radius: Float
): Unit

Convenience for setRoundRect(int,int,int,int,float)