OutputFrameBuffer Class¶

This type is an EasyAR Sense API in C#: OutputFrameBuffer . Some descriptions may not apply to Unity environment on this page.

This type is fully wrapped into Unity components: ARSession . There is no need to use this type directly.

Description¶

Output frame buffer.

There is an output frame input port and output frame fetching function. It can be used to convert output frame fetching from asynchronous pattern to synchronous polling pattern, which fits frame by frame rendering.

OutputFrameBuffer occupies one buffer of camera. Use setBufferCapacity of camera to set an amount of buffers that is not less than the sum of amount of buffers occupied by all components. Refer to Overview .

All members of this class is thread-safe.

Methods¶

input¶

C#: public virtual OutputFrameSink input()

Input port.

bufferRequirement¶

C#: public virtual int bufferRequirement()

Camera buffers occupied in this component.

signalOutput¶

C#: public virtual SignalSource signalOutput()

Output port for frame arrival. It can be connected to InputFrameThrottler.signalInput .

peek¶

C#: public virtual Optional< OutputFrame > peek()

Fetches the most recent OutputFrame .

create¶

C#: public static OutputFrameBuffer create()

Creates an instance.

pause¶

C#: public virtual void pause()

Pauses output of OutputFrame . After execution, all results of OutputFrameBuffer.peek will be empty. OutputFrameBuffer.signalOutput is not affected.

resume¶

C#: public virtual void resume()

Resumes output of OutputFrame .