Skip to main content
Version: 0.9.0 (next)

RenderFrameInfo class

Per-frame information from a successful begin-frame. Everything it hands out is in the bound app volume's app content space.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll

public sealed class RenderFrameInfo : IDisposable

Implements: IDisposable

Remarks​

Valid only for the frame it was begun with: read the poses and FOVs before RenderSender.ShowFrame, which ends that frame, then dispose it. Read after that, the getters fail with StatusCode.LogicError, or return the next frame's values once that one is begun; disposing the sender invalidates it. A view index is a position in the sender's layout (RenderSender.GetLayout), in the order of RenderSenderOptions.FrameViews; one out of range fails with StatusCode.LogicError.

Methods​

MemberDescription
GetViewPose(int)The pose to render one view with, in the bound app volume's app content space (right-handed, +Y up, -Z forward, app units). The sender has already taken the viewer's room-space pose through the volume's pose, app pose and app scale, so the application renders its scene in its own coordinates. A view of eye VideoFrameViewEye.None gets the head pose.
GetViewFov(int)The field of view of one view, in view space, in radians. A view of eye VideoFrameViewEye.None gets the left eye's.
Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

GetViewPose​

The pose to render one view with, in the bound app volume's app content space (right-handed, +Y up, -Z forward, app units). The sender has already taken the viewer's room-space pose through the volume's pose, app pose and app scale, so the application renders its scene in its own coordinates. A view of eye VideoFrameViewEye.None gets the head pose.

public Result<Pose> GetViewPose(int viewIndex)

Parameters

NameTypeDescription
viewIndexint

Returns: Result<Pose>

GetViewFov​

The field of view of one view, in view space, in radians. A view of eye VideoFrameViewEye.None gets the left eye's.

public Result<Fov> GetViewFov(int viewIndex)

Parameters

NameTypeDescription
viewIndexint

Returns: Result<Fov>

Dispose​

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()