API Reference · Lights

ProbeCaptureOptions

Namespace: Ava3D

public sealed class ProbeCaptureOptions

Settings for EnvironmentProbe.CaptureAsync.

Properties

MemberDescription
string CacheKey { get; set; }

Stored on the returned image's EnvironmentImage.Name, for the caller's own bookkeeping — a cache key that says what the pixels are a capture of.

Func<Node, bool> Exclude { get; set; }

Nodes this returns true for are left out of the capture: the probe's own fixture, a helmet, a HUD. Null captures everything the room would otherwise show.

int FaceSize { get; set; }

Side length of each of the six rendered faces, in pixels. 128 by default — Unity's own default for a baked reflection probe; use 256 for a hero room.

bool IncludeProbes { get; set; }

Whether the capture can see this scene's own room probes. False by default, so a probe never feeds back into itself and captures taken in any order agree; true asks for whatever the scene would actually show, its own room reflections included.

See also