eggisasa / AR3-1 Docs

AR3-1 API Reference

Comprehensive API documentation for eggisasa's augmented reality framework. Access class definitions, method parameters, and code examples for all platform features.

Navigation

Core API Classes

ARSession

Manages AR session lifecycle, handles device compatibility and configuration settings.

new ARSession({
format: 'ar3-1',
resolution: 2048,
multiuser: true
)

ARAnchor

Manages object placement and spatial tracking within the AR environment.

const anchor = ARAnchor.create({
position: {x:1, y:0, z:3},
type: 'persistent'
)

ARRenderer

3D rendering engine with support for dynamic lighting and environment mapping.

ARRenderer.configure(
{
msaa: true,
ambientLight: 0.7,
resolutionScale: 2
}

API Version Differences

Feature AR3-1 AR3-2 (Beta)
Persistent Anchors ✓ 30m range ✓ 100m range
Multi-user Sync ✓ 50ms latency ✓ 30ms latency
Depth Buffer ✓ 24-bit ✓ 32-bit

Sample API Usage


// Initialize core session
const app = new ARSession({
    version: '3.1',
    spatial: true,
    maxAnchors: 100
// Create persistent anchor
const landmark = ARAnchor.create({
    position: {x:2.5, y:1.8, z:4.2},
    type: 'landmark',
    metadata: {
        label: "Example Landmark",
        description: "Test anchor for reference tracking"
    });