OverlaySettings.Builder

public final class OverlaySettings.Builder

A builder for OverlaySettings instances.

Summary

Public constructors

Creates a new Builder.

Public methods
OverlaySettings

Creates an instance of OverlaySettings, using defaults if values are unset.
OverlaySettings.Builder
@CanIgnoreReturnValue
setAlphaScale(@FloatRange(from = 0) float alphaScale)

Sets the alpha scale value of the overlay, altering its translucency.
OverlaySettings.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.
OverlaySettings.Builder
@CanIgnoreReturnValue
setOverlayFrameAnchor(
    @FloatRange(from = "-1", to = 1) float x,
    @FloatRange(from = "-1", to = 1) float y
)

Sets the coordinates for the anchor point of the overlay frame.
OverlaySettings.Builder

Sets the rotation of the overlay, counter-clockwise.
OverlaySettings.Builder
@CanIgnoreReturnValue
setScale(float x, float y)

Sets the scaling of the overlay.
OverlaySettings.Builder

Sets whether input overlay comes from an HDR source.

Public constructors

Builder

public Builder()

Creates a new Builder.

Public methods

build

public OverlaySettings build()

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

setAlphaScale

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

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

An alphaScale value of 1 means no change is applied. A value below 1 increases translucency, and a value above 1 reduces translucency.

Set to always return 1 by default.

setBackgroundFrameAnchor

@CanIgnoreReturnValue
public OverlaySettings.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.

The coordinates are specified in Normalised Device Coordinates (NDCs) relative to the background frame. Set to always return (0,0) (the center of the background frame) by default.

For example, a value of (+1,+1) will move the overlay frames's anchor point to the top right corner of the background frame.

Parameters
@FloatRange(from = "-1", to = 1) float x

The NDC x-coordinate in the range [-1, 1].
@FloatRange(from = "-1", to = 1) float y

The NDC y-coordinate in the range [-1, 1].

setOverlayFrameAnchor

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

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

The anchor point is the point inside the overlay frame that is placed on the background frame anchor

The coordinates are specified in Normalised Device Coordinates (NDCs) relative to the overlay frame. Set to return (0,0) (the center of the overlay frame) by default.

For example, a value of (+1,-1) will result in the overlay frame being positioned with its bottom right corner positioned at the background frame anchor.

Parameters
@FloatRange(from = "-1", to = 1) float x

The NDC x-coordinate in the range [-1, 1].
@FloatRange(from = "-1", to = 1) float y

The NDC y-coordinate in the range [-1, 1].

setRotationDegrees

@CanIgnoreReturnValue
public OverlaySettings.Builder setRotationDegrees(float rotationDegree)

Sets the rotation of the overlay, counter-clockwise.

The overlay is rotated at the center of its frame.

Parameters
float rotationDegree

The desired degrees of rotation, counter-clockwise.

setScale

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

Sets the scaling of the overlay.

Parameters
float x

The desired scaling in the x axis of the overlay.
float y

The desired scaling in the y axis of the overlay.

setUsesHdr

@CanIgnoreReturnValue
public OverlaySettings.Builder setUsesHdr(boolean useHdr)

Sets whether input overlay comes from an HDR source. If true, colors will be in linear RGB BT.2020. If false, colors will be in linear RGB BT.709.

Set to false by default.