api / org.gradle.nativeplatform.platform / NativePlatform

NativePlatform

@Incubating interface NativePlatform : Platform, Describable

A target platform for building native binaries. Each target platform is given a name, and may optionally be given a specific Architecture and/or OperatingSystem to target.

 model { platforms { windows_x86 { architecture "i386" operatingSystem "windows" } } } 

Functions

architecture

abstract fun architecture(name: String): Unit

Sets the cpu architecture being targeted.

The architecture is provided as a string name, which is translated into one of the supported architecture types.

getArchitecture

abstract fun getArchitecture(): Architecture

The cpu architecture being targeted. Defaults to the default architecture produced by the tool chain.

getOperatingSystem

abstract fun getOperatingSystem(): OperatingSystem

The operating system being targeted. Defaults to the default operating system targeted by the tool chain (normally the current operating system).

operatingSystem

abstract fun operatingSystem(name: String): Unit

Sets the operating system being targeted.

The operating system is provided as a string name, which is translated into one of the supported operating system types.

Inherited Functions

getDisplayName

abstract fun getDisplayName(): String

Returns a human consumable name for this platform.

getName

abstract fun getName(): String

Inheritors

CppPlatform

interface CppPlatform : NativePlatform

A target platform for building C++ binaries.

SwiftPlatform

interface SwiftPlatform : NativePlatform

A target platform for building Swift binaries.