plugin/com.smushytaco.lwjgl_gradle/LwjglExtension

LwjglExtension

abstract class LwjglExtension @Inject constructor(objects: ObjectFactory, providers: ProviderFactory, dependencies: DependencyHandler, repositories: RepositoryHandler)

Gradle extension used to configure LWJGL dependencies for a project.

This extension is registered by LwjglPlugin under the name "lwjgl" and exposes a small DSL for:

Choosing the LWJGL version via version.
Controlling how native artifacts are resolved via usePredefinedPlatforms and platforms.
Adding LWJGL modules and presets to implementation / testImplementation via the implementation and testImplementation helper functions.

Parameters

objects

The Gradle ObjectFactory used to create lazy Property and ListProperty instances that are compatible with the configuration cache.

providers

The Gradle ProviderFactory used to lazily inspect system properties and derive the current runningPlatform in a configuration-cache-friendly way.

dependencies

The project's DependencyHandler used internally to register the resolved LWJGL dependencies on the appropriate configurations.

repositories

The project's RepositoryHandler used internally to register the LWJGL snapshot Maven repository when snapshot versions are in use.

Constructors

LwjglExtension

@Inject

constructor(objects: ObjectFactory, providers: ProviderFactory, dependencies: DependencyHandler, repositories: RepositoryHandler)

Types

Companion

object Companion

Holds constants used by LwjglExtension.

Properties

autoAddSnapshotRepository

val autoAddSnapshotRepository: Property<Boolean>

Whether the plugin should automatically add a snapshot repository when the configured LWJGL version ends with -SNAPSHOT.

platforms

val platforms: ListProperty<String>

List of LWJGL native classifiers to resolve when usePredefinedPlatforms is enabled.

runningPlatform

val runningPlatform: Provider<String>

Lazily computes the current host platform classifier for LWJGL natives.

snapshotRepositoryName

val snapshotRepositoryName: Property<String>

The name assigned to the automatically-added snapshot repository.

snapshotRepositoryUrl

val snapshotRepositoryUrl: Property<String>

URL of the Maven repository to use for resolving LWJGL snapshot versions.

usePredefinedPlatforms

val usePredefinedPlatforms: Property<Boolean>

Controls whether native artifacts should be resolved using platforms.

version

val version: Property<String>

LWJGL version to use for all resolved artifacts.

Functions

api

fun api(vararg entries: LwjglEntry, wireNativesTo: String? = "runtimeOnly")

fun api(vararg entries: LwjglEntry, wireNativesTo: Named)

fun api(entries: Iterable<LwjglEntry>, wireNativesTo: String? = "runtimeOnly")

fun api(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the api configuration.

compileOnly

fun compileOnly(vararg entries: LwjglEntry, wireNativesTo: String? = null)

fun compileOnly(vararg entries: LwjglEntry, wireNativesTo: Named)

fun compileOnly(entries: Iterable<LwjglEntry>, wireNativesTo: String? = null)

fun compileOnly(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the compileOnly configuration.

implementation

fun implementation(vararg entries: LwjglEntry, wireNativesTo: String? = "runtimeOnly")

fun implementation(vararg entries: LwjglEntry, wireNativesTo: Named)

fun implementation(entries: Iterable<LwjglEntry>, wireNativesTo: String? = "runtimeOnly")

fun implementation(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the implementation configuration.

into

fun into(compileConfiguration: String?, runtimeConfiguration: String?, vararg entries: LwjglEntry)

fun into(compileConfiguration: String?, runtimeConfiguration: String?, entries: Iterable<LwjglEntry>)

fun into(compileConfiguration: String?, runtimeConfiguration: Named?, vararg entries: LwjglEntry)

fun into(compileConfiguration: String?, runtimeConfiguration: Named?, entries: Iterable<LwjglEntry>)

fun into(compileConfiguration: Named?, runtimeConfiguration: String?, vararg entries: LwjglEntry)

fun into(compileConfiguration: Named?, runtimeConfiguration: String?, entries: Iterable<LwjglEntry>)

fun into(compileConfiguration: Named?, runtimeConfiguration: Named?, vararg entries: LwjglEntry)

fun into(compileConfiguration: Named?, runtimeConfiguration: Named?, entries: Iterable<LwjglEntry>)

Registers LWJGL modules on the specified configuration.

runtimeOnly

fun runtimeOnly(vararg entries: LwjglEntry)

fun runtimeOnly(entries: Iterable<LwjglEntry>)

Registers LWJGL modules on the runtimeOnly configuration.

testApi

fun testApi(vararg entries: LwjglEntry, wireNativesTo: String? = "testRuntimeOnly")

fun testApi(vararg entries: LwjglEntry, wireNativesTo: Named)

fun testApi(entries: Iterable<LwjglEntry>, wireNativesTo: String? = "testRuntimeOnly")

fun testApi(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the testApi configuration.

testCompileOnly

fun testCompileOnly(vararg entries: LwjglEntry, wireNativesTo: String? = null)

fun testCompileOnly(vararg entries: LwjglEntry, wireNativesTo: Named)

fun testCompileOnly(entries: Iterable<LwjglEntry>, wireNativesTo: String? = null)

fun testCompileOnly(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the testCompileOnly configuration.

testImplementation

fun testImplementation(vararg entries: LwjglEntry, wireNativesTo: String? = "testRuntimeOnly")

fun testImplementation(vararg entries: LwjglEntry, wireNativesTo: Named)

fun testImplementation(entries: Iterable<LwjglEntry>, wireNativesTo: String? = "testRuntimeOnly")

fun testImplementation(entries: Iterable<LwjglEntry>, wireNativesTo: Named)

Registers LWJGL modules on the testImplementation configuration.

testRuntimeOnly

fun testRuntimeOnly(vararg entries: LwjglEntry)

fun testRuntimeOnly(entries: Iterable<LwjglEntry>)

Registers LWJGL modules on the testRuntimeOnly configuration.