Getting Started with EasyAR


An Augmenter is a renderer that gets a frame from trackers and render the camera image as background in AR scenes.

Public Properties


Public Functions

FrameNewFrame(ImageTracker tracker) (until 1.2.1)
FrameNewFrame(BarCodeScanner barcode) (until 1.2.1)
FrameNewFrame() (since 1.3.0)
boolAttachCamera(CameraDevice cam) (since 1.3.0)
boolDetachCamera(CameraDevice cam) (since 1.3.0)


Creates a Augmenter object.

Image.PixelFormat VideoBackgroundTextureFormat

Gets current background camera image format. If current frame is not available, Image.PixelFormat.Unknown will be returned.

Vector2I VideoBackgroundTextureSize

Gets current background camera image size. This size may change if CameraDevice size changed. If current frame is not available, {0, 0} will be returned.

Frame NewFrame(ImageTracker tracker) (until 1.2.1)

Gets a new frame from ImageTracker.

Frame NewFrame(BarCodeScanner barcode) (until 1.2.1)

Gets a new frame from BarCodeScanner.

Frame NewFrame() (since 1.3.0)

Gets a new frame. An CameraDevice must be attached before getting a valid frame.

bool AttachCamera(CameraDevice cam) (since 1.3.0)

Attach CameraDevice to the Augmenter. Frame from newFrame will be empty if no CameraDevice has been attached.

bool DetachCamera(CameraDevice cam) (since 1.3.0)

Detach CameraDevice from the Augmenter.