You.i Engine
CYIVideoSurfaceTexture Class Referenceabstract

Detailed Description

Representation of a CYIAbstractVideoPlayer's video surface, if the player is rendering to a texture.

All CYIVideoSurfaceTexture types will implicitly report the CAPABITILIES RENDER_TO_TEXTURE, MULTIPLE_VIEWS, TRANSLATE, SCALE, FREE_TRANSFORM, and OPACITY.

#include <player/YiVideoSurfaceTexture.h>

Inheritance diagram for CYIVideoSurfaceTexture:

Protected Member Functions

virtual void Init () override
 
 CYIVideoSurfaceTexture (uint32_t uCapabilities=0)
 
const std::shared_ptr< CYIMaterial > & GetMaterial () const
 
- Protected Member Functions inherited from CYIVideoSurface
 CYIVideoSurface (uint32_t uCapabilities)
 
void SetSize (const glm::ivec2 &videoSize)
 
virtual void OnAttached (CYIVideoSurfaceView *pVideoSurfaceView)
 
virtual void OnDetached (CYIVideoSurfaceView *pVideoSurfaceView)
 

Friends

class CYIVideoSurfaceView
 
class CYIAbstractVideoPlayer
 

Additional Inherited Members

- Public Types inherited from CYIVideoSurface
enum  CAPABILITIES {
  RENDER_TO_TEXTURE = 0x1,
  MULTIPLE_VIEWS = 0x2,
  TRANSLATE = 0x4,
  SCALE = 0x8,
  FREE_TRANSFORM = 0x10,
  OPACITY = 0x20
}
 
- Public Member Functions inherited from CYIVideoSurface
virtual ~CYIVideoSurface ()
 
uint32_t GetCapabilities () const
 
void SetClosedCaptionsDispatcher (CYIClosedCaptionsDispatcher *pDispatcher)
 
CYIClosedCaptionsDispatcherGetClosedCaptionsDispatcher () const
 
const glm::ivec2 & GetSize () const
 
- Public Member Functions inherited from CYIScriptableObject
 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObjectoperator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementationGetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 
virtual const CYIRuntimeTypeInfoGetRuntimeTypeInfoForScriptObject () const
 
- Public Attributes inherited from CYIVideoSurface
CYISignal< const glm::ivec2 & > SizeChanged
 

Constructor & Destructor Documentation

CYIVideoSurfaceTexture::CYIVideoSurfaceTexture ( uint32_t  uCapabilities = 0)
protected

The default value will result in RENDER_TO_TEXTURE, MULTIPLE_VIEWS, TRANSLATE, SCALE, FREE_TRANSFORM, and OPACITY.

Any further capabilities can be reported by providing an input to the constructor.

Member Function Documentation

const std::shared_ptr<CYIMaterial>& CYIVideoSurfaceTexture::GetMaterial ( ) const
protected

Contains a material (shader and texture combination) that is capable of rendering the current video frame.

See also
CAPABILITIES
virtual void CYIVideoSurfaceTexture::Init ( )
overrideprotectedvirtual

Will call InitializeMaterial and InitializeTexture.

Reimplemented from CYIVideoSurface.

Friends And Related Function Documentation

friend class CYIAbstractVideoPlayer
friend
friend class CYIVideoSurfaceView
friend

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