filament/io.github.erkko68.filament/View/DepthOfFieldOptions

DepthOfFieldOptions

actual class 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.

expect class 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.

actual class 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.

actual class 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.

actual class 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

Link copied to clipboard
actual constructor()
expect constructor()
constructor()
actual constructor()
actual constructor()

Types

Link copied to clipboard
actual enum Filter : Enum<View.DepthOfFieldOptions.Filter>

Depth of Field filter types.

expect enum Filter : Enum<View.DepthOfFieldOptions.Filter>

Depth of Field filter types.

actual enum Filter : Enum<View.DepthOfFieldOptions.Filter>

Depth of Field filter types.

actual enum Filter : Enum<View.DepthOfFieldOptions.Filter>

Depth of Field filter types.

actual enum Filter : Enum<View.DepthOfFieldOptions.Filter>

Depth of Field filter types.

Properties

Link copied to clipboard
actual var backgroundRingCount: Int

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

expect var backgroundRingCount: Int

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

actual var backgroundRingCount: Int

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

actual var backgroundRingCount: Int

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

actual var backgroundRingCount: Int

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

Link copied to clipboard
actual var cocScale: Float

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

expect var cocScale: Float

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

actual var cocScale: Float

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

actual var cocScale: Float

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

actual var cocScale: Float

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

Link copied to clipboard
actual var enabled: Boolean

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

expect var enabled: Boolean

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

actual var enabled: Boolean

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

actual var enabled: Boolean

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

actual var enabled: Boolean

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

Link copied to clipboard
actual var fastGatherRingCount: Int

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

expect var fastGatherRingCount: Int

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

actual var fastGatherRingCount: Int

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

actual var fastGatherRingCount: Int

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

actual var fastGatherRingCount: Int

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

Link copied to clipboard
actual var filter: View.DepthOfFieldOptions.Filter

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

expect var filter: View.DepthOfFieldOptions.Filter

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

actual var filter: View.DepthOfFieldOptions.Filter

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

actual var filter: View.DepthOfFieldOptions.Filter

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

actual var filter: View.DepthOfFieldOptions.Filter

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

Link copied to clipboard
actual var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The actual 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.

expect var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The actual 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.

actual var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The actual 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.

actual var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The actual 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.

actual var foregroundRingCount: Int

Number of rings used by the gather kernels for foreground. The number of rings affects quality and performance. The actual 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.

Link copied to clipboard
actual var maxApertureDiameter: Float

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

expect var maxApertureDiameter: Float

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

actual var maxApertureDiameter: Float

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

actual var maxApertureDiameter: Float

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

actual var maxApertureDiameter: Float

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

Link copied to clipboard
actual 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.

expect 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.

actual 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.

actual 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.

actual 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.

Link copied to clipboard
actual 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.

expect 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.

actual 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.

actual 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.

actual 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.

Link copied to clipboard
val native: View.DepthOfFieldOptions
Link copied to clipboard
actual var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.

expect var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.

actual var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.

actual var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.

actual var nativeResolution: Boolean

Perform DoF processing at native resolution. Default: false.

Generated by Dokka
© 2026 Copyright