Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.76 KB

README.md

File metadata and controls

58 lines (41 loc) · 1.76 KB
Raw

Build And Publish Sonatype Nexus (Snapshots) Kotlin License

Awake

Awake is a cross-platform graphics wrapper and framework (OpenGL, Metal & Vulkan)

Note The library is still unstable and might encounter issues. While the Android and iOS platform have stable and functional opengl support, the Desktop platform that utilizes the lwjgl/glfw window is still in the development and experimental phase.

Features Supported

  • OpenGL
    • Android OpenGL
    • iOS OpenGL
    • Desktop OpenGL (JVM experimental due to in-compatibility to compose AWT)
  • Vulkan
    • Android Vulkan (TODO)
    • iOS MoltenVK / Metal (TODO)
    • Desktop (TODO)

Installation

To use this library in your Kotlin Multiplatform project, follow the steps below:

  1. Add the library as a dependency in your Gradle build.gradle.kts
implementation("io.github.ronjunevaldoz:awake-core:1.0.0-SNAPSHOT")
repositories {
    maven("https://s01.oss.sonatype.org/content/repositories/snapshots")
}

Example Usage

  1. Initialize the AwakeContext

        // by default debug is enabled
    // default fps is set to 60
    // default gl version is set to 3
    AwakeContext.init()

  2. Create a sample compose component

License

This library is released under the Apache, Version 2.0 License..