Unverified Commit 86d0d0a2 authored by Pavel's avatar Pavel Committed by GitHub

Add comment to clarify that coordinates refer a baseline position, not a top...

Add comment to clarify that coordinates refer a baseline position, not a top left angle of text rectangle (#788)
parent 2dd06f0a
...@@ -541,6 +541,9 @@ open class Canvas internal constructor(ptr: NativePointer, managed: Boolean, int ...@@ -541,6 +541,9 @@ open class Canvas internal constructor(ptr: NativePointer, managed: Boolean, int
return this return this
} }
/**
* Draw a text [blob] with baseline starting at [x] [y] with [paint]
*/
fun drawTextBlob(blob: TextBlob, x: Float, y: Float, paint: Paint): Canvas { fun drawTextBlob(blob: TextBlob, x: Float, y: Float, paint: Paint): Canvas {
Stats.onNativeCall() Stats.onNativeCall()
try { try {
...@@ -553,6 +556,9 @@ open class Canvas internal constructor(ptr: NativePointer, managed: Boolean, int ...@@ -553,6 +556,9 @@ open class Canvas internal constructor(ptr: NativePointer, managed: Boolean, int
return this return this
} }
/**
* Draw a text [line] with baseline starting at [x] [y] with [paint]
*/
fun drawTextLine(line: TextLine, x: Float, y: Float, paint: Paint): Canvas { fun drawTextLine(line: TextLine, x: Float, y: Float, paint: Paint): Canvas {
line.textBlob?.use { blob -> blob.let { drawTextBlob(it, x, y, paint) } } line.textBlob?.use { blob -> blob.let { drawTextBlob(it, x, y, paint) } }
return this return this
......
...@@ -22,6 +22,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize ...@@ -22,6 +22,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize
val PTR = TextLine_nGetFinalizer() val PTR = TextLine_nGetFinalizer()
} }
/**
* distance to reserve above baseline, typically negative
*/
val ascent: Float val ascent: Float
get() { get() {
Stats.onNativeCall() Stats.onNativeCall()
...@@ -32,6 +35,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize ...@@ -32,6 +35,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize
} }
} }
/**
* height of an upper-case letter, zero if unknown, typically negative
*/
val capHeight: Float val capHeight: Float
get() { get() {
Stats.onNativeCall() Stats.onNativeCall()
...@@ -42,6 +48,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize ...@@ -42,6 +48,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize
} }
} }
/**
* height of lower-case 'x', zero if unknown, typically negative
*/
val xHeight: Float val xHeight: Float
get() { get() {
Stats.onNativeCall() Stats.onNativeCall()
...@@ -52,6 +61,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize ...@@ -52,6 +61,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize
} }
} }
/**
* distance to reserve below baseline, typically positive
*/
val descent: Float val descent: Float
get() { get() {
Stats.onNativeCall() Stats.onNativeCall()
...@@ -62,6 +74,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize ...@@ -62,6 +74,9 @@ class TextLine internal constructor(ptr: NativePointer) : Managed(ptr, _Finalize
} }
} }
/**
* distance to add between lines, typically positive or zero
*/
val leading: Float val leading: Float
get() { get() {
Stats.onNativeCall() Stats.onNativeCall()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment