IFlashPlayer

C++
struct IFlashPlayer {
  enum EOptions {
    RENDER_EDGE_AA = 0x04,
    INIT_FIRST_FRAME = 0x08,
    ENABLE_MOUSE_SUPPORT = 0x10,
    DEFAULT = RENDER_EDGE_AA|INIT_FIRST_FRAME|ENABLE_MOUSE_SUPPORT,
    DEFAULT_NO_MOUSE = RENDER_EDGE_AA|INIT_FIRST_FRAME
  };
  enum ECategory {
    eCat_RequestMeshCacheResetBit = 0x80000000,
    eCat_Default = 0,
    eCat_Temp = 1,
    eCat_Temp_TessHeavy = 1|eCat_RequestMeshCacheResetBit,
    eCat_User = 3
  };
  enum EScaleModeType {
    eSM_NoScale,
    eSM_ShowAll,
    eSM_ExactFit,
    eSM_NoBorder
  };
  enum EAlignType {
    eAT_Center,
    eAT_TopCenter,
    eAT_BottomCenter,
    eAT_CenterLeft,
    eAT_CenterRight,
    eAT_TopLeft,
    eAT_TopRight,
    eAT_BottomLeft,
    eAT_BottomRight
  };
};
File

IFlashPlayer.h

IFlashPlayer::EAlignType Enumeration
C++
enum EAlignType {
  eAT_Center,
  eAT_TopCenter,
  eAT_BottomCenter,
  eAT_CenterLeft,
  eAT_CenterRight,
  eAT_TopLeft,
  eAT_TopRight,
  eAT_BottomLeft,
  eAT_BottomRight
};
File

IFlashPlayer.h

IFlashPlayer::ECategory Enumeration
C++
enum ECategory {
  eCat_RequestMeshCacheResetBit = 0x80000000,
  eCat_Default = 0,
  eCat_Temp = 1,
  eCat_Temp_TessHeavy = 1|eCat_RequestMeshCacheResetBit,
  eCat_User = 3
};
File

IFlashPlayer.h

IFlashPlayer::EOptions Enumeration
C++
enum EOptions {
  RENDER_EDGE_AA = 0x04,
  INIT_FIRST_FRAME = 0x08,
  ENABLE_MOUSE_SUPPORT = 0x10,
  DEFAULT = RENDER_EDGE_AA|INIT_FIRST_FRAME|ENABLE_MOUSE_SUPPORT,
  DEFAULT_NO_MOUSE = RENDER_EDGE_AA|INIT_FIRST_FRAME
};
File

IFlashPlayer.h

Members
Members
Description
RENDER_EDGE_AA = 0x04
Enables edge anti-aliased flash rendering.
INIT_FIRST_FRAME = 0x08
Init objects of first frame when creating instance of flash file.
ENABLE_MOUSE_SUPPORT = 0x10
Enable mouse input support.
IFlashPlayer::EScaleModeType Enumeration
C++
enum EScaleModeType {
  eSM_NoScale,
  eSM_ShowAll,
  eSM_ExactFit,
  eSM_NoBorder
};
File

IFlashPlayer.h

IFlashPlayer::~IFlashPlayer Destructor
C++
virtual ~IFlashPlayer();
IFlashPlayer::AddRef Method
C++
virtual void AddRef() = 0;
IFlashPlayer::Advance Method
C++
virtual void Advance(float deltaTime) = 0;
IFlashPlayer::AvoidStencilClear Method
C++
virtual void AvoidStencilClear(bool avoid) = 0;
IFlashPlayer::ClientToScreen Method

Translates the client coordinates to the screen coordinates

C++
virtual void ClientToScreen(int& x, int& y) const = 0;
IFlashPlayer::CreateArray Method
C++
virtual bool CreateArray(IFlashVariableObject*& pVarObj) = 0;
IFlashPlayer::CreateFunction Method
C++
virtual bool CreateFunction(IFlashVariableObject*& pFuncVarObj, IActionScriptFunction* pFunc, void* pUserData = 0) = 0;
IFlashPlayer::CreateObject Method
C++
virtual bool CreateObject(const char* pClassName, const SFlashVarValue* pArgs, unsigned int numArgs, IFlashVariableObject*& pVarObj) = 0;
IFlashPlayer::CreateString Method
C++
virtual bool CreateString(const char* pString, IFlashVariableObject*& pVarObj) = 0;
IFlashPlayer::CreateStringW Method
C++
virtual bool CreateStringW(const wchar_t* pString, IFlashVariableObject*& pVarObj) = 0;
IFlashPlayer::EnableMaskedRendering Method
C++
virtual void EnableMaskedRendering(bool enable) = 0;
Description

special render mode for Crysis 2 HUD markers (in stereo)

IFlashPlayer::ExtendCanvasToViewport Method
C++
virtual void ExtendCanvasToViewport(bool extend) = 0;
IFlashPlayer::GetBackgroundAlpha Method
C++
virtual float GetBackgroundAlpha() const = 0;
IFlashPlayer::GetCurrentFrame Method
C++
virtual unsigned int GetCurrentFrame() const = 0;
IFlashPlayer::GetFilePath Method
C++
virtual const char* GetFilePath() const = 0;
IFlashPlayer::GetFrameCount Method

General property queries

C++
virtual unsigned int GetFrameCount() const = 0;
IFlashPlayer::GetFrameRate Method
C++
virtual float GetFrameRate() const = 0;
IFlashPlayer::GetHeight Method
C++
virtual int GetHeight() const = 0;
IFlashPlayer::GetMetadata Method
C++
virtual size_t GetMetadata(char* pBuff, unsigned int buffSize) const = 0;
IFlashPlayer::GetScissorRect Method
C++
virtual void GetScissorRect(int& x0, int& y0, int& width, int& height) const = 0;
IFlashPlayer::GetVariable Method (char*, IFlashVariableObject*&)
C++
virtual bool GetVariable(const char* pPathToVar, IFlashVariableObject*& pVarObj) const = 0;
IFlashPlayer::GetVariable Method (char*, SFlashVarValue&)
C++
virtual bool GetVariable(const char* pPathToVar, SFlashVarValue& value) const = 0;
IFlashPlayer::GetVariableArray Method
C++
virtual bool GetVariableArray(EFlashVariableArrayType type, const char* pPathToVar, unsigned int index, void* pData, unsigned int count) const = 0;
IFlashPlayer::GetVariableArraySize Method
C++
virtual unsigned int GetVariableArraySize(const char* pPathToVar) const = 0;
IFlashPlayer::GetViewAlignment Method
C++
virtual EAlignType GetViewAlignment() const = 0;
IFlashPlayer::GetViewport Method
C++
virtual void GetViewport(int& x0, int& y0, int& width, int& height, float& aspectRatio) const = 0;
IFlashPlayer::GetViewScaleMode Method
C++
virtual EScaleModeType GetViewScaleMode() const = 0;
IFlashPlayer::GetVisible Method
C++
virtual bool GetVisible() const = 0;
IFlashPlayer::GetWidth Method
C++
virtual int GetWidth() const = 0;
IFlashPlayer::GotoFrame Method
C++
virtual void GotoFrame(unsigned int frameNumber) = 0;
IFlashPlayer::GotoLabeledFrame Method
C++
virtual bool GotoLabeledFrame(const char* pLabel, int offset = 0) = 0;
IFlashPlayer::HasLooped Method
C++
virtual bool HasLooped() const = 0;
IFlashPlayer::IFlashPlayer Constructor
C++
IFlashPlayer();
IFlashPlayer::Invoke Method
C++
virtual bool Invoke(const char* pMethodName, const SFlashVarValue* pArgs, unsigned int numArgs, SFlashVarValue* pResult = 0) = 0;
IFlashPlayer::Invoke0 Method
C++
bool Invoke0(const char* pMethodName, SFlashVarValue* pResult = 0);
Description

more to come...

IFlashPlayer::Invoke1 Method
C++
bool Invoke1(const char* pMethodName, const SFlashVarValue& arg, SFlashVarValue* pResult = 0);
IFlashPlayer::IsAvailable Method
C++
virtual bool IsAvailable(const char* pPathToVar) const = 0;
IFlashPlayer::IsPaused Method
C++
virtual bool IsPaused() const = 0;
IFlashPlayer::Load Method
C++
virtual bool Load(const char* pFilePath, unsigned int options = DEFAULT, unsigned int cat = eCat_Default) = 0;
Description

Initialization

IFlashPlayer::Pause Method
C++
virtual void Pause(bool pause) = 0;
IFlashPlayer::Release Method
C++
virtual void Release() = 0;
IFlashPlayer::Render Method
C++
virtual void Render(bool stereo = false) = 0;
IFlashPlayer::RenderPlaybackLockless Method
C++
virtual void RenderPlaybackLockless(bool stereo = false, bool finalPlayback = true) = 0;
IFlashPlayer::RenderRecordLockless Method
C++
virtual size_t RenderRecordLockless() = 0;
IFlashPlayer::ResetDirtyFlags Method
C++
virtual void ResetDirtyFlags() = 0;
Description

Coordinate Translation

IFlashPlayer::Restart Method
C++
virtual void Restart() = 0;
Description

Execution State

IFlashPlayer::ScreenToClient Method

Translates the screen coordinates to the client coordinates

C++
virtual void ScreenToClient(int& x, int& y) const = 0;
IFlashPlayer::SendCharEvent Method
C++
virtual void SendCharEvent(const SFlashCharEvent& charEvent) = 0;
IFlashPlayer::SendCursorEvent Method
C++
virtual void SendCursorEvent(const SFlashCursorEvent& cursorEvent) = 0;
IFlashPlayer::SendKeyEvent Method
C++
virtual void SendKeyEvent(const SFlashKeyEvent& keyEvent) = 0;
IFlashPlayer::SetBackgroundAlpha Method
C++
virtual void SetBackgroundAlpha(float alpha) = 0;
IFlashPlayer::SetBackgroundColor Method
C++
virtual void SetBackgroundColor(const ColorB& color) = 0;
Description

Rendering

IFlashPlayer::SetCompositingDepth Method
C++
virtual void SetCompositingDepth(float depth) = 0;
IFlashPlayer::SetExternalInterfaceHandler Method
C++
virtual void SetExternalInterfaceHandler(IExternalInterfaceHandler* pHandler, void* pUserData = 0) = 0;
IFlashPlayer::SetFSCommandHandler Method

Callbacks & Events

C++
virtual void SetFSCommandHandler(IFSCommandHandler* pHandler, void* pUserData = 0) = 0;
IFlashPlayer::SetScissorRect Method
C++
virtual void SetScissorRect(int x0, int y0, int width, int height) = 0;
IFlashPlayer::SetVariable Method (char*, IFlashVariableObject*)
C++
virtual bool SetVariable(const char* pPathToVar, const IFlashVariableObject* pVarObj) = 0;
IFlashPlayer::SetVariable Method (char*, SFlashVarValue&)
C++
virtual bool SetVariable(const char* pPathToVar, const SFlashVarValue& value) = 0;
Description

Action Script

IFlashPlayer::SetVariableArray Method
C++
virtual bool SetVariableArray(EFlashVariableArrayType type, const char* pPathToVar, unsigned int index, const void* pData, unsigned int count) = 0;
IFlashPlayer::SetViewAlignment Method
C++
virtual void SetViewAlignment(EAlignType viewAlignment) = 0;
IFlashPlayer::SetViewport Method
C++
virtual void SetViewport(int x0, int y0, int width, int height, float aspectRatio = 1.0f) = 0;
IFlashPlayer::SetViewScaleMode Method
C++
virtual void SetViewScaleMode(EScaleModeType scaleMode) = 0;
IFlashPlayer::SetVisible Method
C++
virtual void SetVisible(bool visible) = 0;
IFlashPlayer::StereoEnforceFixedProjectionDepth Method
C++
virtual void StereoEnforceFixedProjectionDepth(bool enforce) = 0;
IFlashPlayer::StereoSetCustomMaxParallax Method
C++
virtual void StereoSetCustomMaxParallax(float maxParallax = -1.0f) = 0;