Skip to content

Most visited

Recently visited

navigation

Outline

public final class Outline
extends Object

java.lang.Object
   ↳ android.graphics.Outline


Defines a simple shape, used for bounding graphical regions.

Can be computed for a View, or computed by a Drawable, to drive the shape of shadows cast by a View, or to clip the contents of the View.

See also:

Summary

Public constructors

Outline()

Constructs an empty Outline.

Outline(Outline src)

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

Public methods

boolean canClip()

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

float getAlpha()

Returns the alpha represented by the Outline.

float getRadius()

Returns the rounded rect radius, if set, or a value less than 0 if a path has been set via setConvexPath(Path).

boolean getRect(Rect outRect)

Populates outBounds with the outline bounds, if set, and returns true.

boolean isEmpty()

Returns whether the Outline is empty.

void offset(int dx, int dy)

Offsets the Outline by (dx,dy)

void set(Outline src)

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

void setAlpha(float alpha)

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

void setConvexPath(Path convexPath)

Sets the Constructs an Outline from a convex path.

void setEmpty()

Sets the outline to be empty.

void setOval(Rect rect)

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

void setOval(int left, int top, int right, int bottom)

Sets the outline to the oval defined by input rect.

void setRect(Rect rect)

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

void setRect(int left, int top, int right, int bottom)

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

void setRoundRect(Rect rect, float radius)

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

void setRoundRect(int left, int top, int right, int bottom, float radius)

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

Inherited methods

From class java.lang.Object

Public constructors

Outline

added in API level 21
Outline ()

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

Outline

added in API level 21
Outline (Outline src)

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

Parameters
src Outline

This value must never be null.

Public methods

canClip

added in API level 21
boolean canClip ()

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

Currently, only Outlines that can be represented as a rectangle, circle, or round rect support clipping.

Returns
boolean

See also:

getAlpha

added in API level 21
float getAlpha ()

Returns the alpha represented by the Outline.

Returns
float

getRadius

added in API level 24
float getRadius ()

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

Returns
float the rounded rect radius, or value < 0

getRect

added in API level 24
boolean getRect (Rect outRect)

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 setConvexPath(Path), returns false.

Parameters
outRect Rect: the rect to populate with the outline bounds, if set

This value must never be null.

Returns
boolean true if outBounds was populated with outline bounds, or false if no outline bounds are set

isEmpty

added in API level 21
boolean isEmpty ()

Returns whether the Outline is empty.

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

Returns
boolean

See also:

offset

added in API level 22
void offset (int dx, 
                int dy)

Offsets the Outline by (dx,dy)

Parameters
dx int

dy int

set

added in API level 21
void set (Outline src)

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

Parameters
src Outline: Source outline to copy from.

This value must never be null.

setAlpha

added in API level 21
void setAlpha (float alpha)

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.

Parameters
alpha float

Value is between 0.0 and 1.0 inclusive.

setConvexPath

added in API level 21
void setConvexPath (Path convexPath)

Sets the Constructs an Outline from a convex path.

Parameters
convexPath Path

This value must never be null.

setEmpty

added in API level 21
void setEmpty ()

Sets the outline to be empty.

See also:

setOval

added in API level 21
void setOval (Rect rect)

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

Parameters
rect Rect

This value must never be null.

setOval

added in API level 21
void setOval (int left, 
                int top, 
                int right, 
                int bottom)

Sets the outline to the oval defined by input rect.

Parameters
left int

top int

right int

bottom int

setRect

added in API level 21
void setRect (Rect rect)

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

Parameters
rect Rect

This value must never be null.

setRect

added in API level 21
void setRect (int left, 
                int top, 
                int right, 
                int bottom)

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

Parameters
left int

top int

right int

bottom int

setRoundRect

added in API level 21
void setRoundRect (Rect rect, 
                float radius)

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

Parameters
rect Rect

This value must never be null.

radius float

setRoundRect

added in API level 21
void setRoundRect (int left, 
                int top, 
                int right, 
                int bottom, 
                float radius)

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

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

Parameters
left int

top int

right int

bottom int

radius float

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)