SurfaceConfiguration

Artifact: androidx.webgpu:webgpu

View Source

Added in 1.0.0-alpha01

---

Kotlin |Java

public final class SurfaceConfiguration

---

A descriptor for configuring a surface.

Summary

Public constructors
SurfaceConfiguration(     @NonNull GPUDevice device,     int width,     int height,     int format,     int usage,     @NonNull int[] viewFormats,     int alphaMode,     int presentMode )

Public methods
final int	getAlphaMode()
final @NonNull GPUDevice	getDevice() The device that will be used to render to the surface.
final int	getFormat() The preferred texture format for the surface's textures.
final int	getHeight() The height of the surface's textures.
final int	getPresentMode()
final int	getUsage() The texture usage flags for textures created by the surface.
final @NonNull int[]	getViewFormats()
final int	getWidth() The width of the surface's textures.
final void	setAlphaMode(int alphaMode)
final void	setDevice(@NonNull GPUDevice device) The device that will be used to render to the surface.
final void	setFormat(int format) The preferred texture format for the surface's textures.
final void	setHeight(int height) The height of the surface's textures.
final void	setPresentMode(int presentMode)
final void	setUsage(int usage) The texture usage flags for textures created by the surface.
final void	setViewFormats(@NonNull int[] viewFormats)
final void	setWidth(int width) The width of the surface's textures.

Public constructors

SurfaceConfiguration

Added in 1.0.0-alpha01

public SurfaceConfiguration(
    @NonNull GPUDevice device,
    int width,
    int height,
    int format,
    int usage,
    @NonNull int[] viewFormats,
    int alphaMode,
    int presentMode
)

Public methods

getAlphaMode

Added in 1.0.0-alpha01

public final int getAlphaMode()

getDevice

Added in 1.0.0-alpha01

public final @NonNull GPUDevice getDevice()

The device that will be used to render to the surface.

getFormat

Added in 1.0.0-alpha01

public final int getFormat()

The preferred texture format for the surface's textures.

getHeight

Added in 1.0.0-alpha01

public final int getHeight()

The height of the surface's textures.

getPresentMode

Added in 1.0.0-alpha01

public final int getPresentMode()

getUsage

Added in 1.0.0-alpha01

public final int getUsage()

The texture usage flags for textures created by the surface.

getViewFormats

Added in 1.0.0-alpha01

public final @NonNull int[] getViewFormats()

getWidth

Added in 1.0.0-alpha01

public final int getWidth()

The width of the surface's textures.

setAlphaMode

Added in 1.0.0-alpha01

public final void setAlphaMode(int alphaMode)

setDevice

Added in 1.0.0-alpha01

public final void setDevice(@NonNull GPUDevice device)

The device that will be used to render to the surface.

setFormat

Added in 1.0.0-alpha01

public final void setFormat(int format)

The preferred texture format for the surface's textures.

setHeight

Added in 1.0.0-alpha01

public final void setHeight(int height)

The height of the surface's textures.

setPresentMode

Added in 1.0.0-alpha01

public final void setPresentMode(int presentMode)

setUsage

Added in 1.0.0-alpha01

public final void setUsage(int usage)

The texture usage flags for textures created by the surface.

setViewFormats

Added in 1.0.0-alpha01

public final void setViewFormats(@NonNull int[] viewFormats)

setWidth

Added in 1.0.0-alpha01

public final void setWidth(int width)

The width of the surface's textures.