Stroke

Artifact: androidx.compose.ui:ui-graphics

View Source

Added in 1.0.0

Common/All

• Cmn

  class Stroke : DrawStyle

kotlin.Any
↳	androidx.compose.ui.graphics.drawscope.DrawStyle
	↳	androidx.compose.ui.graphics.drawscope.Stroke

---

DrawStyle that provides information for drawing content with a stroke

Summary

Constants
const Float	DefaultMiter = 4.0f Default miter length used in combination with joins	Cmn
const Float	HairlineWidth = 0.0f Width to indicate a hairline stroke of 1 pixel	Cmn

Public companion properties
StrokeCap	DefaultCap Default cap used for line endings	Cmn
StrokeJoin	DefaultJoin Default join style used for connections between line and curve segments	Cmn

Public constructors
Stroke(     width: Float,     miter: Float,     cap: StrokeCap,     join: StrokeJoin,     pathEffect: PathEffect? )	Cmn

Public functions
open operator Boolean	equals(other: Any?)	Cmn
open Int	hashCode()	Cmn
open String	toString()	Cmn

Public properties
StrokeCap	cap Return the paint's Cap, controlling how the start and end of stroked lines and paths are treated.	Cmn
StrokeJoin	join Set's the treatment where lines and curve segments join on a stroked path.	Cmn
Float	miter Set the stroke miter value.	Cmn
PathEffect?	pathEffect Effect to apply to the stroke, null indicates a solid stroke line is to be drawn	Cmn
Float	width Configure the width of the stroke in pixels	Cmn

Constants

DefaultMiter

Cmn

const val DefaultMiter = 4.0f: Float

Default miter length used in combination with joins

HairlineWidth

Cmn

const val HairlineWidth = 0.0f: Float

Width to indicate a hairline stroke of 1 pixel

Public companion properties

DefaultCap

Cmn

Added in 1.0.0

val DefaultCap: StrokeCap

Default cap used for line endings

DefaultJoin

Cmn

Added in 1.0.0

val DefaultJoin: StrokeJoin

Default join style used for connections between line and curve segments

Public constructors

Stroke

Cmn

Stroke(
    width: Float = 0.0f,
    miter: Float = DefaultMiter,
    cap: StrokeCap = DefaultCap,
    join: StrokeJoin = DefaultJoin,
    pathEffect: PathEffect? = null
)

Parameters
width: Float = 0.0f	Configure the width of the stroke in pixels
miter: Float = DefaultMiter	Set the stroke miter value. This is used to control the behavior of miter joins when the joins angle is sharp. This value must be >= 0
cap: StrokeCap = DefaultCap	Return the paint's Cap, controlling how the start and end of stroked lines and paths are treated. The default is StrokeCap.Butt
join: StrokeJoin = DefaultJoin	Set's the treatment where lines and curve segments join on a stroked path. The default is StrokeJoin.Miter
pathEffect: PathEffect? = null	Effect to apply to the stroke, null indicates a solid stroke line is to be drawn

Public functions

equals

Cmn

open operator fun equals(other: Any?): Boolean

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

Public properties

cap

Cmn

Added in 1.0.0

val cap: StrokeCap

Return the paint's Cap, controlling how the start and end of stroked lines and paths are treated. The default is StrokeCap.Butt

join

Cmn

Added in 1.0.0

val join: StrokeJoin

Set's the treatment where lines and curve segments join on a stroked path. The default is StrokeJoin.Miter

miter

Cmn

Added in 1.0.0

val miter: Float

Set the stroke miter value. This is used to control the behavior of miter joins when the joins angle is sharp. This value must be >= 0

pathEffect

Cmn

Added in 1.0.0

val pathEffect: PathEffect?

Effect to apply to the stroke, null indicates a solid stroke line is to be drawn

width

Cmn

Added in 1.0.0

val width: Float

Configure the width of the stroke in pixels