commonMain.KalugaImage.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.

 */

package com.splendo.kaluga.resources

/**
 * Class describing an image.
 */
expect class KalugaImage

@Deprecated("Due to name clashes with platform classes and API changes this class has been renamed and changed to an interface. It will be removed in a future release.", ReplaceWith("KalugaColor"))
typealias Image = KalugaImage

/**
 * A [KalugaImage] tinted with a given [KalugaColor]
 * @property image the [KalugaImage] to tint
 * @property tint the [KalugaColor] to tint the image with
 */
data class TintedImage(val image: KalugaImage, val tint: KalugaColor)

/**
 * Attempts to create a new [KalugaImage] that is tinted in a given [KalugaColor]
 * @param color The [KalugaColor] to use for tinting.
 * @return The [TintedImage]
 */
fun KalugaImage.tinted(color: KalugaColor) = TintedImage(this, color)