StaticOverlaySettings.Builder

Kotlin |Java

public final class StaticOverlaySettings.Builder

A builder for StaticOverlaySettings instances.

Summary

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

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

Public constructors

Builder

public Builder()

Creates a new Builder.

Public methods

build

public StaticOverlaySettings build()

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

setAlphaScale

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setAlphaScale(@FloatRange(from = 0) float alphaScale)

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

See also
`getAlphaScale`

setBackgroundFrameAnchor

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setBackgroundFrameAnchor(
    @FloatRange(from = "-1", to = 1) float x,
    @FloatRange(from = "-1", to = 1) float y
)

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

See also
`getBackgroundFrameAnchor`

setHdrLuminanceMultiplier

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setHdrLuminanceMultiplier(float hdrLuminanceMultiplier)

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

See also
`getHdrLuminanceMultiplier`

setOverlayFrameAnchor

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setOverlayFrameAnchor(
    @FloatRange(from = "-1", to = 1) float x,
    @FloatRange(from = "-1", to = 1) float y
)

Sets the coordinates for the anchor point within the overlay.

See also
`getOverlayFrameAnchor`

setRotationDegrees

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setRotationDegrees(float rotationDegree)

Sets the rotation of the overlay, counter-clockwise.

See also
`getRotationDegrees`

setScale

@CanIgnoreReturnValue
public StaticOverlaySettings.Builder setScale(float x, float y)

Sets the scaling of the overlay.

See also
`getScale`