OverlaySettings.Builder
class OverlaySettings.Builder
A builder for OverlaySettings instances.
Summary
Public functions |
|
|---|---|
OverlaySettings! |
build()Creates an instance of |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSets the alpha scale value of the overlay, altering its translucency. |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSets the coordinates for the anchor point of the overlay within the background frame. |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSet the luminance multiplier of an SDR overlay when overlaid on a HDR frame. |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSets the coordinates for the anchor point of the overlay frame. |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSets the rotation of the overlay, counter-clockwise. |
OverlaySettings.Builder! |
@CanIgnoreReturnValueSets the scaling of the overlay. |
Public functions
build
fun build(): OverlaySettings!
Creates an instance of OverlaySettings, using defaults if values are unset.
setAlphaScale
@CanIgnoreReturnValue
fun setAlphaScale(alphaScale: @FloatRange(from = 0) Float): OverlaySettings.Builder!
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
fun setBackgroundFrameAnchor(
x: @FloatRange(from = "-1", to = 1) Float,
y: @FloatRange(from = "-1", to = 1) Float
): OverlaySettings.Builder!
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 | |
|---|---|
x: @FloatRange(from = "-1", to = 1) Float |
The NDC x-coordinate in the range [-1, 1]. |
y: @FloatRange(from = "-1", to = 1) Float |
The NDC y-coordinate in the range [-1, 1]. |
setHdrLuminanceMultiplier
@CanIgnoreReturnValue
fun setHdrLuminanceMultiplier(hdrLuminanceMultiplier: Float): OverlaySettings.Builder!
Set the luminance multiplier of an SDR overlay when overlaid on a HDR frame.
Scales the luminance of the overlay to adjust the output brightness of the overlay on the frame. The default value is 1, which scales the overlay colors into the standard HDR luminance within the processing pipeline. Use 0.5 to scale the luminance of the overlay to SDR range, so that no extra luminance is added.
Currently only supported on text overlays
setOverlayFrameAnchor
@CanIgnoreReturnValue
fun setOverlayFrameAnchor(
x: @FloatRange(from = "-1", to = 1) Float,
y: @FloatRange(from = "-1", to = 1) Float
): OverlaySettings.Builder!
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 | |
|---|---|
x: @FloatRange(from = "-1", to = 1) Float |
The NDC x-coordinate in the range [-1, 1]. |
y: @FloatRange(from = "-1", to = 1) Float |
The NDC y-coordinate in the range [-1, 1]. |
setRotationDegrees
@CanIgnoreReturnValue
fun setRotationDegrees(rotationDegree: Float): OverlaySettings.Builder!
Sets the rotation of the overlay, counter-clockwise.
The overlay is rotated at the center of its frame.
| Parameters | |
|---|---|
rotationDegree: Float |
The desired degrees of rotation, counter-clockwise. |
setScale
@CanIgnoreReturnValue
fun setScale(x: Float, y: Float): OverlaySettings.Builder!
Sets the scaling of the overlay.