StaticOverlaySettings.Builder

Kotlin |Java

class StaticOverlaySettings.Builder

A builder for StaticOverlaySettings instances.

Summary

Public constructors
`Builder()` Creates a new `Builder`.

Public functions
`StaticOverlaySettings!`	`build()` Creates an instance of `StaticOverlaySettings`, using defaults if values are unset.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setAlphaScale(alphaScale: @FloatRange(from = 0) Float)` Sets the alpha scale value of the overlay, altering its translucency.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setBackgroundFrameAnchor( x: @FloatRange(from = "-1", to = 1) Float, y: @FloatRange(from = "-1", to = 1) Float )` Sets the coordinates for the anchor point of the overlay within the background frame.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setHdrLuminanceMultiplier(hdrLuminanceMultiplier: Float)` Set the luminance multiplier of an SDR overlay when overlaid on a HDR frame.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setOverlayFrameAnchor( x: @FloatRange(from = "-1", to = 1) Float, y: @FloatRange(from = "-1", to = 1) Float )` Sets the coordinates for the anchor point within the overlay.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setRotationDegrees(rotationDegree: Float)` Sets the rotation of the overlay, counter-clockwise.
`StaticOverlaySettings.Builder!`	`@CanIgnoreReturnValue setScale(x: Float, y: Float)` Sets the scaling of the overlay.

Public constructors

Builder

Builder()

Creates a new Builder.

Public functions

build

fun build(): StaticOverlaySettings!

Creates an instance of StaticOverlaySettings, using defaults if values are unset.

setAlphaScale

@CanIgnoreReturnValue
fun setAlphaScale(alphaScale: @FloatRange(from = 0) Float): StaticOverlaySettings.Builder!

Sets the alpha scale value of the overlay, altering its translucency.

See also
`getAlphaScale`

setBackgroundFrameAnchor

@CanIgnoreReturnValue
fun setBackgroundFrameAnchor(
    x: @FloatRange(from = "-1", to = 1) Float,
    y: @FloatRange(from = "-1", to = 1) Float
): StaticOverlaySettings.Builder!

Sets the coordinates for the anchor point of the overlay within the background frame.

See also
`getBackgroundFrameAnchor`

setHdrLuminanceMultiplier

@CanIgnoreReturnValue
fun setHdrLuminanceMultiplier(hdrLuminanceMultiplier: Float): StaticOverlaySettings.Builder!

Set the luminance multiplier of an SDR overlay when overlaid on a HDR frame.

See also
`getHdrLuminanceMultiplier`

setOverlayFrameAnchor

@CanIgnoreReturnValue
fun setOverlayFrameAnchor(
    x: @FloatRange(from = "-1", to = 1) Float,
    y: @FloatRange(from = "-1", to = 1) Float
): StaticOverlaySettings.Builder!

Sets the coordinates for the anchor point within the overlay.

See also
`getOverlayFrameAnchor`

setRotationDegrees

@CanIgnoreReturnValue
fun setRotationDegrees(rotationDegree: Float): StaticOverlaySettings.Builder!

Sets the rotation of the overlay, counter-clockwise.

See also
`getRotationDegrees`

setScale

@CanIgnoreReturnValue
fun setScale(x: Float, y: Float): StaticOverlaySettings.Builder!

Sets the scaling of the overlay.

See also
`getScale`