androidLibMain.KalugaColor.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resources Show documentation
Collection of Kotlin Flow based libraries
There is a newer version: 1.5.1
/*
 Copyright 2022 Splendo Consulting B.V. The Netherlands

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

 */

@file:JvmName("AndroidKalugaColor")

package com.splendo.kaluga.resources

/**
 * Class describing a color
 */
actual typealias KalugaColor = Int

/**
 * Gets the red value of the color in a range between `0.0` and `1.0`
 */
actual val KalugaColor.red: Double get() = redInt.toDouble() / 255.0

/**
 * Gets the red value of the color in a range between `0` and `255`
 */
actual val KalugaColor.redInt: Int get() = android.graphics.Color.red(this)

/**
 * Gets the green value of the color in a range between `0.0` and `1.0`
 */
actual val KalugaColor.green: Double get() = greenInt.toDouble() / 255.0

/**
 * Gets the green value of the color in a range between `0` and `255`
 */
actual val KalugaColor.greenInt: Int get() = android.graphics.Color.green(this)

/**
 * Gets the blue value of the color in a range between `0.0` and `1.0`
 */
actual val KalugaColor.blue: Double get() = blueInt.toDouble() / 255.0

/**
 * Gets the blue value of the color in a range between `0` and `255`
 */
actual val KalugaColor.blueInt: Int get() = android.graphics.Color.blue(this)

/**
 * Gets the alpha value of the color in a range between `0.0` and `1.0`
 */
actual val KalugaColor.alpha: Double get() = alphaInt.toDouble() / 255.0

/**
 * Gets the alpha value of the color in a range between `0` and `255`
 */
actual val KalugaColor.alphaInt: Int get() = android.graphics.Color.alpha(this)

/**
 * Creates a [KalugaColor] using red, green, blue, and (optional) alpha, all ranging between `0.0` and `1.0`.
 * @param red The red color value ranging between `0.0` and `1.0`.
 * @param green The green color value ranging between `0.0` and `1.0`.
 * @param blue The blue color value ranging between `0.0` and `1.0`.
 * @param alpha The alpha color value ranging between `0.0` and `1.0`. Defaults to `1.0`
 * @return The [KalugaColor] with the corresponding red, green, blue, and alpha values
 */
actual fun colorFrom(red: Double, green: Double, blue: Double, alpha: Double): KalugaColor {
    return android.graphics.Color.argb((alpha * 255.0).toInt(), (red * 255.0).toInt(), (green * 255.0).toInt(), (blue * 255.0).toInt())
}

/**
 * Creates a [KalugaColor] using red, green, blue, and (optional) alpha, all ranging between `0` and `255`.
 * @param redInt The red color value ranging between `0` and `255`.
 * @param greenInt The green color value ranging between `0` and `255`.
 * @param blueInt The blue color value ranging between `0` and `255`.
 * @param alphaInt The alpha color value ranging between `0` and `255`. Defaults to `255`
 * @return The [KalugaColor] with the corresponding red, green, blue, and alpha values
 */
actual fun colorFrom(redInt: Int, greenInt: Int, blueInt: Int, alphaInt: Int): KalugaColor = android.graphics.Color.argb(alphaInt, redInt, greenInt, blueInt)