SurfaceEntity.EdgeFeatheringParams.SmoothFeather


public final class SurfaceEntity.EdgeFeatheringParams.SmoothFeather extends SurfaceEntity.EdgeFeatheringParams


Summary

Public constructors

SmoothFeather(
    @FloatRange(from = 0.0, to = 0.5) float leftRight,
    @FloatRange(from = 0.0, to = 0.5) float topBottom
)

Public methods

final float

a Float which controls the canvas-relative radius of the edge fadeout on the left and right edges of the SurfaceEntity canvas.

final float

a Float which controls the canvas-relative radius of the edge fadeout on the top and bottom edges of the SurfaceEntity canvas.

Public constructors

SmoothFeather

Added in 1.0.0-alpha05
public SmoothFeather(
    @FloatRange(from = 0.0, to = 0.5) float leftRight,
    @FloatRange(from = 0.0, to = 0.5) float topBottom
)

Public methods

getLeftRight

Added in 1.0.0-alpha05
public final float getLeftRight()

a Float which controls the canvas-relative radius of the edge fadeout on the left and right edges of the SurfaceEntity canvas.

getTopBottom

Added in 1.0.0-alpha05
public final float getTopBottom()

a Float which controls the canvas-relative radius of the edge fadeout on the top and bottom edges of the SurfaceEntity canvas.

A radius of 0.05 represents 5% of the width of the visible canvas surface. Please note that this is scaled by the aspect ratio of Quad-shaped canvases.

Applications are encouraged to use ZeroFeather or set this to 0.0 on Spherical canvases. The behavior is only defined for values between 0.0f - 0.5f. Default values are 0.0f.