Environment Probes

This page is a supplement to the AR Foundation Environment Probes manual. The following sections only contain information about APIs where ARCore exhibits unique platform-specific behavior.

Tip

When developing an AR app, refer to both the AR Foundation documentation as well as the required packages for each platform you support.

Native pointer

XREnvironmentProbe.nativePtr values returned by this package contain a pointer to the following struct:

typedef struct UnityXRNativeEnvironmentProbe
{
    int version;
    void* arImageCubemap[6];
} UnityXRNativeEnvironmentProbe;


This package also provides a header file containing the definitions of various native data structs including UnityXRNativeEnvironmentProbe. It can be found in the package directory under Includes~/UnityXRNativePtrs.h.

Cast void* arImageCubemap to an ArImageCubemap handle in C++ using the following example code:

// Marhshal the native environment probe data from the XREnvironmentProbe.nativePtr in C#
UnityXRNativeEnvironmentProbe nativeEnvironmentProbeData;
ArImageCubemap* cubemapHandle = static_cast<ArImageCubemap*>(&nativeEnvironmentProbeData.arImageCubemap);


To learn more about native pointers and their usage, refer to Extending AR Foundation.