docs/android/dokka/filament-android/com.google.android.filament/-view/-depth-of-field-options/index.md
//filament-android/com.google.android.filament/View/DepthOfFieldOptions
open 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
| Camera |
| DepthOfFieldOptions | [main] |
| constructor() |
| Name | Summary |
|---|---|
| Filter | [main] |
| enum Filter |
| Name | Summary |
|---|---|
| backgroundRingCount | [main] |
| open var backgroundRingCount: Int | |
| number of kernel rings for background tiles | |
| cocAspectRatio | [main] |
| open var cocAspectRatio: Float | |
| width/height aspect ratio of the circle of confusion (simulate anamorphic lenses) | |
| cocScale | [main] |
| open var cocScale: Float | |
| circle of confusion scale factor (amount of blur) | |
| enabled | [main] |
| open var enabled: Boolean | |
| enable or disable depth of field effect | |
| fastGatherRingCount | [main] |
| open var fastGatherRingCount: Int | |
| number of kernel rings for fast tiles | |
| filter | [main] |
| open var filter: View.DepthOfFieldOptions.Filter | |
| filter to use for filling gaps in the kernel | |
| foregroundRingCount | [main] |
| open var foregroundRingCount: Int | |
| number of kernel rings for foreground tiles | |
| maxApertureDiameter | [main] |
| open var maxApertureDiameter: Float | |
| maximum aperture diameter in meters (zero to disable rotation) | |
| maxBackgroundCOC | [main] |
| open var maxBackgroundCOC: Int | |
| maximum circle-of-confusion in pixels for the background, must be in [0, 32] range. | |
| maxForegroundCOC | [main] |
| open var maxForegroundCOC: Int | |
| maximum circle-of-confusion in pixels for the foreground, must be in [0, 32] range. | |
| nativeResolution | [main] |
| open var nativeResolution: Boolean | |
| perform DoF processing at native resolution |