https://github.com/icerockdev/moko-graphics

Graphics primitives for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-graphics

android graphics ios kotlin kotlin-multiplatform kotlin-native moko

Last synced: 2 months ago
JSON representation

Graphics primitives for mobile (android & ios) Kotlin Multiplatform development

• Host: GitHub
• URL: https://github.com/icerockdev/moko-graphics
• Owner: icerockdev
• License: apache-2.0
• Created: 2019-10-15T05:52:37.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-08T14:18:09.000Z (4 months ago)
• Last Synced: 2024-09-08T16:43:23.616Z (4 months ago)
• Topics: android, graphics, ios, kotlin, kotlin-multiplatform, kotlin-native, moko
• Language: Kotlin
• Homepage: https://moko.icerock.dev/
• Size: 220 KB
• Stars: 19
• Watchers: 7
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• kmp-awesome - MOKO Graphics - Graphics primitives (Libraries / 🎨 Graphics)

README

        
![moko-graphics](img/logo.png)  

[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://img.shields.io/maven-central/v/dev.icerock.moko/graphics) ](https://repo1.maven.org/maven2/dev/icerock/moko/graphics) ![kotlin-version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=dev.icerock.moko&name=graphics)

# Mobile Kotlin graphics

This is a Kotlin Multiplatform library that provides graphics primitives to common code.  

## Table of Contents

- [Features](#features)

- [Requirements](#requirements)

- [Installation](#installation)

- [Usage](#usage)

- [Samples](#samples)

- [Set Up Locally](#set-up-locally)

- [Contributing](#contributing)

- [License](#license)

## Features

- **Color** converting according to the platform-side requirements (argb/rgba);

- All Kotlin Multiplatform targets support.

## Requirements

- Gradle version 6.8+

- Android API 16+

- iOS version 11.0+

## Installation

root build.gradle  

```groovy

allprojects {

    repositories {

      mavenCentral()

    }

}

```

project build.gradle

```groovy

dependencies {

    commonMainApi("dev.icerock.moko:graphics:0.9.0")

}

```

## Usage

### Color

```kotlin

val red = Color(

    red = 0xFF,

    green = 0x00,

    blue = 0x00,

    alpha = 0xFF

)

val rgba: Long = red.rgba

val argb: Long = red.argb // android compatible

```

## Samples

Please see more examples in the [sample directory](sample).

## Set Up Locally 

- The [graphics directory](graphics) contains the `graphics` library;

- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps;

## Contributing

All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.

The `develop` branch is pushed to `master` on release.

For more details on contributing please see the [contributing guide](CONTRIBUTING.md).

## License

        

    Copyright 2019 IceRock MAG Inc.

    

    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.