Open Reality Reference Guide
FBEventVideoFrameRendering Class Reference

Event: Video Frame offline Rendering Event. More...

#include <fbsystem.h>

Inheritance diagram for FBEventVideoFrameRendering:

Public Types

enum  EState {
  eBeginRendering = 1 ,
  eRendering ,
  eEndRendering
}
 video rendering state More...
 

Public Member Functions

 FBEventVideoFrameRendering (HKEventBase pEvent)
 Constructor. More...
 
kInt64 GetFrameNumber ()
 returns the frame number the video renderer is about to render. More...
 
kInt64 GetFrameCount ()
 returns the total number of frames the video renderer is rendering. More...
 
FBEventVideoFrameRendering::EState GetState ()
 returns the current state of the video renderer. More...
 
- Public Member Functions inherited from FBEvent
 FBEvent (HKEvent pEvent)
 Constructor. More...
 

Additional Inherited Members

- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Detailed Description

Event: Video Frame offline Rendering Event.

Definition at line 100 of file fbsystem.h.

Member Enumeration Documentation

◆ EState

enum EState

video rendering state

Enumerator
eBeginRendering 

State before video renderer renders all the frames.

eRendering 

State before video renderer renders each frame.

eEndRendering 

State after video renderer renders all the frames.

Definition at line 109 of file fbsystem.h.

Constructor & Destructor Documentation

◆ FBEventVideoFrameRendering()

FBEventVideoFrameRendering ( HKEventBase  pEvent)

Constructor.

Parameters
pEventBase event (internal) to obtain information from.

Member Function Documentation

◆ GetFrameCount()

kInt64 GetFrameCount ( )

returns the total number of frames the video renderer is rendering.

Returns
the total number of frames.

◆ GetFrameNumber()

kInt64 GetFrameNumber ( )

returns the frame number the video renderer is about to render.

Returns
the frame number.

◆ GetState()

returns the current state of the video renderer.

Returns
the current state.

The documentation for this class was generated from the following file: