WVR_SubmitFrame¶

Struct and enumeration¶

The srtuct WVR_TextureParams_t is defined as below.

struct WVR_TextureParams¶

Texture parameters.

Aggregate the texture related information which needs to be updated to runtime. The texture parameters can be obtained via WVR_GetTexture or assigned a valid texture directly. The WVR_SubmitFrame need this struct as an argument to pass current texture identiy to runtime.

Public Members

WVR_Texture_t id¶

Correspond to the name of texture to identify texture entity in graphics library such as OpenGL.

typedef void* WVR_Texture_t¶

WVR_Texture_t: type define the name of texture.

The srtuct WVR_PoseState_t is defined as below.

struct WVR_PoseState¶

Describes a single pose in rotation matrix form for a tracked object.

Public Members

bool isValidPose¶

The label of valid(true)/invalid(false) pose.

WVR_Matrix4f_t poseMatrix¶

The pose data (ratation, position) in matrix form (refer to WVR_Matrix4f).

WVR_Vector3f_t velocity¶

The velocity of pose (refer to WVR_Vector3f).

WVR_Vector3f_t angularVelocity¶

The angular velocity of pose.

bool is6DoFPose¶

The label of 6 DoF(true)/3 DoF(false) pose.

int64_t timestamp¶

Absolute time (in nanosecond) of pose.

WVR_Vector3f_t acceleration¶

The acceleration of pose.

WVR_Vector3f_t angularAcceleration¶

The angular acceleration of pose.

float predictedMilliSec¶

Number of milliseconds from now to predict poses.

WVR_PoseOriginModel originModel¶

The origin model of pose.

enum WVR_Eye¶

The sides of target scene.

Specify the side of eye for targe scene.

Values:

WVR_Eye_Left = 0¶

WVR_Eye_Left: Left eye id.

WVR_Eye_Right = 1¶

WVR_Eye_Right: Right eye id.

enum WVR_SubmitExtend¶

Extend the add-on functionality for WVR_SubmitFrame.

WVR_SubmitFrame need this flag to specify invoking path. Currently, the default funcationality is available for the runtime submit texture target process.

Values:

WVR_SubmitExtend_Default = 0x00¶

WVR_SubmitExtend_Default: The default process to submit texture to display.

enum WVR_SubmitError¶

The return type of API WVR_SubmitFrame.

Enumerate the error type of submitting frame.

Values:

WVR_SubmitError_None = 0¶

WVR_SubmitError_None: No error

WVR_SubmitError_InvalidTexture = 400¶

WVR_SubmitError_InvalidTexture: The submitted texture is invalid. Make sure texture is correct and not in use.

WVR_SubmitError_ThreadStop = 401¶

WVR_SubmitError_ThreadStop: The submitted thread stops in the runtime.

WVR_SubmitError_BufferSubmitFailed = 402¶

WVR_SubmitError_BufferSubmitFailed: The submitted buffer encounters error in the runtime.

WVR_SubmitError_Max = 65535¶

WVR_SubmitError_Max: Maxium value to reserve bit word among compilers .

How to use¶

Here is an example for the function:

// Must initialize render runtime once before calling all rendering-related API.
WVR_RenderInitParams_t param = {WVR_GraphicsApiType_OpenGL, WVR_RenderConfig_Timewarp_Asynchronous};
WVR_RenderError pError = WVR_RenderInit(&param);
if (pError != WVR_RenderError_None) {
    LOGE("Render init failed - Error[%d]", pError);
}

std::vector<FrameBufferObject*> LeftEyeFBO;
std::vector<FrameBufferObject*> RightEyeFBO;
FrameBufferObject* fbo;
int QueueLength = 10;

uint32_t RenderWidth = 0, RenderHeight = 0;

WVR_GetRenderTargetSize(&RenderWidth, &RenderHeight);
void* LeftEyeQ = WVR_ObtainTextureQueue(WVR_TextureTarget_2D, WVR_TextureFormat_RGBA, WVR_TextureType_UnsignedByte, RenderWidth, RenderHeight, 0);
void* RightEyeQ = WVR_ObtainTextureQueue(WVR_TextureTarget_2D, WVR_TextureFormat_RGBA, WVR_TextureType_UnsignedByte, RenderWidth, RenderHeight, 0);
for (int i = 0; i < QueueLength; i++) {

    fbo = new FrameBufferObject((int)WVR_GetTexture(LeftEyeQ, i).id, RenderWidth, RenderHeight);
    LeftEyeFBO.push_back(fbo);

    fbo = new FrameBufferObject((int)WVR_GetTexture(RightEyeQ, i).id, RenderWidth, RenderHeight);
    RightEyeFBO.push_back(fbo);
}

if (eEye == WVR_Eye_Left) {
    // Left Eye
    LeftEyeFBO.at(mIndex)->bindFrameBuffer();
    LeftEyeFBO.at(mIndex)->glViewportFull();
    glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
    renderScene(WVR_Eye_Left);
    LeftEyeFBO.at(mIndex)->unbindFrameBuffer();
    WVR_TextureParams_t leftEyeTexture = {(WVR_Texture_t)LeftEyeFBO.at(mIndex)->getTextureId()};
    e = WVR_SubmitFrame(WVR_Eye_Left, &leftEyeTexture);
} else {
    // Right Eye
    RightEyeFBO.at(mIndex)->bindFrameBuffer();
    RightEyeFBO.at(mIndex)->glViewportFull();
    glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
    renderScene(WVR_Eye_Right);
    RightEyeFBO.at(mIndex)->unbindFrameBuffer();
    WVR_TextureParams_t rightEyeTexture = {(WVR_Texture_t)RightEyeFBO.at(mIndex)->getTextureId()};
    e = WVR_SubmitFrame(WVR_Eye_Right, &rightEyeTexture);
}

Invoking WVR_GetSyncPose or WVR_GetPoseState multiple times with different predicted time is allowed in programming before calling WVR_SubmitFrame, and in this case, passing the final rendered pose as the third parameter of WVR_SubmitFrame is necessary. Please note that never call these two pose-fetching APIs more than once before calling WVR_SubmitFrame without the pose passed as a parameter. Developer needs to submit both scenes of eyes to trigger render runtime to next steps in normal mode. If the rendered texture is established with multiview extension, the scene is only submitted once each frame regardless of the side of the eye.

if (gMultiview == true) {
    std::vector<FrameBufferObject*> MultiviewFBO;
    FrameBufferObject* fbo;
    int QueueLength = 10;

    // Utilize WVR_TextureTarget_2D_ARRAY as target texture for multiview extension.
    void* MultiviewQ = WVR_ObtainTextureQueue(WVR_TextureTarget_2D_ARRAY, WVR_TextureFormat_RGBA, WVR_TextureType_UnsignedByte, RenderWidth, RenderHeight, 0);

    for (int i = 0; i < QueueLength; i++) {
        fbo = new FrameBufferObject((int)WVR_GetTexture(MultiviewQ, i).id, RenderWidth, RenderHeight);
        MultiviewFBO.push_back(fbo);
    }

    MultiviewFBO.at(mIndex)->bindFrameBuffer(gMultiview);
    MultiviewFBO.at(mIndex)->glViewportFull();
    glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
    renderSceneMultiview();
    MultiviewFBO.at(mIndex)->unbindFrameBuffer(gMultiview);

    IndexMultiview = WVR_GetAvailableTextureIndex(MultiviewQ);
    WVR_TextureParams_t multiviewEyeTexture = WVR_GetTexture(MultiviewQ, IndexMultiview);
    WVR_SubmitError e;
    e = WVR_SubmitFrame(WVR_Eye_Left, &multiviewEyeTexture);
}