Skip to content
threeplaythreeplay

OffscreenOpts

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:75

Options of offscreen().

Properties

Section titled “Properties”

destroy?

Section titled “destroy?”

optional destroy?: boolean

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:79

Destroy it when offscreen (default false).

distance?

Section titled “distance?”

optional distance?: number

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:77

Distance from the camera beyond which the object counts as offscreen (default 100).

frustum?

Section titled “frustum?”

optional frustum?: boolean

Defined in: packages/threeplay/src/plugins/gameplay/types.ts:81

Also count objects outside the camera frustum (default false; uses a bounding sphere of mesh, computed once from its geometry, so it does not follow later geometry changes or skeletal animation).