filament/io.github.erkko68.filament/DepthOfFieldOptions

DepthOfFieldOptions

Options to control Depth of Field (DoF) effect in the scene.

cocScale can be used to set the depth of field blur independently of the camera aperture, e.g., for artistic reasons. This can be achieved by setting: cocScale = cameraAperture / desiredDoFAperture.

Constructors

DepthOfFieldOptions

constructor()

Types

Filter

enum Filter : Enum<DepthOfFieldOptions.Filter>

Depth of Field filter types.

Properties

backgroundRingCount

var backgroundRingCount: Int

Number of rings used by the gather kernels for background. Default: 0.

cocAspectRatio

var cocAspectRatio: Float

Circle-of-confusion aspect ratio, scaling the bokeh horizontally against vertically. 1.0 gives circular bokeh; other values give anamorphic ovals. Default: 1.0.

cocScale

var cocScale: Float

Circle of confusion scale factor (amount of blur). Default: 1.0.

enabled

var enabled: Boolean

Enable or disable depth of field effect. Default: false.

fastGatherRingCount

var fastGatherRingCount: Int

Number of rings used by the gather kernels for fast tiles (regions with similar CoC). Default: 0.

filter

var filter: DepthOfFieldOptions.Filter

Filter to use for filling gaps in the kernel. Default: MEDIAN.

foregroundRingCount

var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The number of samples per pixel is (ringCount * 2 - 1)². Examples: 3 rings = 25 (5x5), 4 rings = 49 (7x7), 5 rings = 81 (9x9), 17 rings = 1089 (33x33). A value of 0 means default (5 on desktop, 3 on mobile). Default: 0.

maxApertureDiameter

var maxApertureDiameter: Float

Maximum aperture diameter in meters (zero to disable rotation). Default: 0.01.

maxBackgroundCOC

var maxBackgroundCOC: Int

Maximum circle-of-confusion in pixels for the background, must be in 0, 32 range. A value of 0 means default (32 on desktop, 24 on mobile). Default: 0.

maxForegroundCOC

var maxForegroundCOC: Int

Maximum circle-of-confusion in pixels for the foreground, must be in 0, 32 range. A value of 0 means default (32 on desktop, 24 on mobile). Default: 0.

nativeResolution

var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.