GPUSurfaceConfiguration

class GPUSurfaceConfiguration

Describes the configuration for a surface.

Summary

Nested types

Builder for GPUSurfaceConfiguration.

Public constructors
GPUSurfaceConfiguration(
    device: GPUDevice,
    width: Int,
    height: Int,
    format: Int,
    usage: Int,
    viewFormats: IntArray,
    alphaMode: Int,
    presentMode: Int
)

Public properties
Int
GPUDevice

The device to use for rendering to the surface.
Int

The texture format for the surface.
Int

The height of the surface's textures.
Int
Int

The allowed usages for the surface's textures.
IntArray
Int

The width of the surface's textures.

Public constructors

GPUSurfaceConfiguration

Added in 1.0.0-alpha06
GPUSurfaceConfiguration(
    device: GPUDevice,
    width: Int,
    height: Int,
    format: Int = TextureFormat.Undefined,
    usage: Int = TextureUsage.RenderAttachment,
    viewFormats: IntArray = intArrayOf(),
    alphaMode: Int = CompositeAlphaMode.Auto,
    presentMode: Int = PresentMode.Fifo
)

Public properties

alphaMode

Added in 1.0.0-alpha06
var alphaMode: Int

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4

device

Added in 1.0.0-alpha06
var device: GPUDevice

The device to use for rendering to the surface.

format

Added in 1.0.0-alpha06
var format: Int

The texture format for the surface.

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101

height

Added in 1.0.0-alpha06
var height: Int

The height of the surface's textures.

presentMode

Added in 1.0.0-alpha06
var presentMode: Int

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4

usage

Added in 1.0.0-alpha06
var usage: Int

The allowed usages for the surface's textures.

Value is either 0 or a combination of the following:

  • 0
  • 1
  • 2
  • 4
  • 8
  • 16
  • 32

viewFormats

Added in 1.0.0-alpha06
var viewFormats: IntArray

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101

width

Added in 1.0.0-alpha06
var width: Int

The width of the surface's textures.