Skip to main content

interface.PickOptions

API > PickOptions

Interface: PickOptions

Extra pick options.

Properties

async

async?: boolean

True to wait for the pick buffers to be available, false to return whatever is in the current pick buffer synchronously.

Remarks

The latter option is more error prone, but useful for e.g. mouse hover operations.

Source

@novorender/core3d/context.ts:1146


pickCameraPlane

pickCameraPlane?: boolean

Return pick without depth.

Source

@novorender/core3d/context.ts:1148


pickOutline

pickOutline?: boolean

Return only picked pixels with clipping outline.

Source

@novorender/core3d/context.ts:1150


sampleDiscRadius

sampleDiscRadius?: number

The radius of the sample disc (0 yields a single pixel).

Source

@novorender/core3d/context.ts:1142