core/dev.tclement.fonticons/FontIconBitmap

FontIconBitmap

fun FontIconBitmap(iconName: String, typeface: Typeface, fontFeatureSettings: String?, tint: Color, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp): Bitmap

A function that draws the icon iconName using the typeface into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

iconName

the icon name (icon aliases/font ligatures are supported)

typeface

the Paint used to draw this icon

fontFeatureSettings

the font feature settings, written in a CSS syntax

tint

the tint to be applied to this icon

size

the size of the icon, by default 24 dp

fun FontIconBitmap(icon: Char, typeface: Typeface, fontFeatureSettings: String?, tint: Color, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp): Bitmap

A function that draws the icon using the typeface into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

icon

the icon Unicode character

typeface

the Paint used to draw this icon

fontFeatureSettings

the font feature settings, written in a CSS syntax

tint

the tint to be applied to this icon

size

the size of the icon, by default 24 dp

fun FontIconBitmap(iconName: String, iconFont: StaticIconFont, tint: Color, context: Context, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon iconName using the iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

iconName

the icon name (icon aliases/font ligatures are supported)

iconFont

the StaticIconFont used to draw this icon

tint

the tint to be applied to this icon

context

the Context used to access some typefaces

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

fun FontIconBitmap(icon: Char, iconFont: StaticIconFont, tint: Color, context: Context, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon using the iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

icon

the icon Unicode character

iconFont

the StaticIconFont used to draw this icon

tint

the tint to be applied to this icon

context

the Context used to access some typefaces

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

@RequiresApi(value = 26)
fun FontIconBitmap(iconName: String, typeface: Typeface, fontFeatureSettings: String?, fontVariationSettings: Array<out FontVariation.Setting>, tint: Color, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon iconName using the variable typeface into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

iconName

the icon name (icon aliases/font ligatures are supported)

typeface

the Paint used to draw this icon

fontFeatureSettings

the font feature settings, written in a CSS syntax

fontVariationSettings

the font variation settings, should not include the optical size ('opsz') or the weight ('wght')

tint

the tint to be applied to this icon

density

the Density used to compute icon dimensions and variation values

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

@RequiresApi(value = 26)
fun FontIconBitmap(icon: Char, typeface: Typeface, fontFeatureSettings: String?, fontVariationSettings: Array<out FontVariation.Setting>, tint: Color, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon using the variable typeface into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

icon

the icon Unicode character

typeface

the Paint used to draw this icon

fontFeatureSettings

the font feature settings, written in a CSS syntax

fontVariationSettings

the font variation settings, should not include the optical size ('opsz') or the weight ('wght')

tint

the tint to be applied to this icon

density

the Density used to compute icon dimensions and variation values

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

@RequiresApi(value = 26)
fun FontIconBitmap(iconName: String, iconFont: VariableIconFont, tint: Color, context: Context, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon iconName using the variable iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

iconName

the icon name (icon aliases/font ligatures are supported)

iconFont

the VariableIconFont used to draw this icon

tint

the tint to be applied to this icon

context

the Context used to access some typefaces

density

the Density used to compute icon dimensions and variation values

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

@RequiresApi(value = 26)
fun FontIconBitmap(icon: Char, iconFont: VariableIconFont, tint: Color, context: Context, density: Density, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

A function that draws the icon using the variable iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint.

Parameters

icon

the icon Unicode character

iconFont

the VariableIconFont used to draw this icon

tint

the tint to be applied to this icon

context

the Context used to access some typefaces

density

the Density used to compute icon dimensions and variation values

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

fun FontIconBitmap(iconName: String, context: Context, tint: Color, iconFont: IconFont, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

Deprecated

This function will be removed in a future release.

Replace with

FontIconBitmap(iconName, iconFont, tint, context, density, size, weight)
Content copied to clipboard

A function that draws the icon iconName using iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint. If iconFont is a variable font, weight will applied as a variation setting, or else the font with the nearest weight will be picked.

Parameters

iconName

the icon name (can be a single character or a string)

context

the Context used to get specific values like density or layout direction

tint

the tint to be applied to this icon

iconFont

the icon font used to draw this icon

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal

fun FontIconBitmap(icon: Char, context: Context, tint: Color, iconFont: IconFont, size: Dp = DEFAULT_ICON_SIZE_DP.dp, weight: FontWeight = FontWeight(DEFAULT_ICON_WEIGHT)): Bitmap

Deprecated

This function will be removed in a future release.

Replace with

FontIconBitmap(icon, iconFont, tint, context, density, size, weight)
Content copied to clipboard

A function that draws the icon using iconFont into a new Bitmap. The icon will be size × size dp, and will be tinted with tint. If iconFont is a variable font, weight will applied as a variation setting, or else the font with the nearest weight will be picked.

Parameters

icon

the icon Unicode character

context

the Context used to get specific values like density or layout direction

tint

the tint to be applied to this icon

iconFont

the icon font used to draw this icon

size

the size of the icon, by default 24 dp

weight

the font weight of the icon, by default FontWeight.Normal