Method RequestData

Namespace

Pinwheel.Vista

Assembly

Pinwheel.Vista.Runtime.dll

RequestData(Bounds, int, int, BiomeDataMask, CancellationSignal)

Requests biome output data for the specified world bounds and resolutions.

BiomeDataRequest RequestData(Bounds worldBounds, int heightMapResolution, int textureResolution, BiomeDataMask consumableDataMask = (BiomeDataMask)-1, CancellationSignal cancellationSignal = null)

Parameters

worldBounds Bounds

World-space bounds to generate data for.

heightMapResolution int

Requested height-related output resolution.

textureResolution int

Requested texture-related output resolution.

consumableDataMask BiomeDataMask

Channels the caller is able to consume, intersected with the biome's own data mask so an output is generated only when the caller can use it and the biome produces it. Defaults to all channels, so a caller that consumes everything can ignore it.

cancellationSignal CancellationSignal

Optional read-only cancellation state owned by the caller. Implementations should pass it to cancellable child operations, stop at safe checkpoints, release partial output, and complete the returned request before exiting. A null signal means the caller did not request cooperative cancellation.

Returns

BiomeDataRequest

A request whose data payload contains the requested outputs on success. The request must reach completion after either successful generation or cancellation cleanup so its caller can safely resume.