FormIt C++ API  v23.0.0 (2023.0.0)
FormIt::kScenesRecordFrameType Struct Reference


kScenesRecordFrame when a single frame is exported to the movie file The payload is the frame count and a blend factor, that indicates whether this frame is a sub frame and the ratio that this frame contributes to the whole frame.

Used for blending multiple frames together for scene transition. If this frame is not a sub frame, the ration is -1.0. To blend all subframes, kScenesRecordFrame will be called a final time with the ratio set to -1. For example for a sub frame : kScenesRecordFrame {frameCount, 0.4} kScenesRecordFrame {frameCount, 0.6} kScenesRecordFrame {frameCount, -1.0} or for a non sub frame: kScenesRecordFrame {frameCount, -1.0}

#include <FormItCoreMessages.h>

Inheritance diagram for FormIt::kScenesRecordFrameType:
FormIt::MessageWithPayloadStruct FormIt::MessageStruct

Public Types

using Payload = 1::pair< size_t, double >
- Public Types inherited from FormIt::MessageStruct
using Payload = void

Public Member Functions

const Payloadextract (FormIt::MessagePayloadStruct const &payload) const
::string message () const override
 message() function. More...
- Public Member Functions inherited from FormIt::MessageStruct
bool operator== (MessageStruct const &right) const
 So we can see if a particular message received is the same as one of the predefined ones using simple comparisons. More...
bool operator!= (MessageStruct const &right) const

Additional Inherited Members

- Protected Member Functions inherited from FormIt::MessageWithPayloadStruct
template<typename T >
const T & cast (MessagePayloadStruct const &payload) const

Member Typedef Documentation

using FormIt::kScenesRecordFrameType::Payload = 1 ::pair<size_t, double>

Member Function Documentation

const Payload& FormIt::kScenesRecordFrameType::extract ( FormIt::MessagePayloadStruct const &  payload) const
::string FormIt::kScenesRecordFrameType::message ( ) const

message() function.

Implements FormIt::MessageStruct.

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