You.i Engine
Public Member Functions | Protected Member Functions | Friends | List of all members
CYIVideoSurfaceTexture Class Referenceabstract
Video Player

Detailed Description

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

All CYIVideoSurfaceTexture types will implicitly report the CYIVideoSurface::Capabilities CYIVideoSurface::Capabilities::RenderToTexture, CYIVideoSurface::Capabilities::MultipleViews, CYIVideoSurface::Capabilities::Translate, CYIVideoSurface::Capabilities::Scale, CYIVideoSurface::Capabilities::FreeTransform, and CYIVideoSurface::Capabilities::Opacity.

#include <player/YiVideoSurfaceTexture.h>

Inheritance diagram for CYIVideoSurfaceTexture:
Inheritance graph
[legend]

Public Member Functions

virtual void Init () override
 
void Clear ()
 
- Public Member Functions inherited from CYIVideoSurface
virtual ~CYIVideoSurface ()
 
Capabilities GetCapabilities () const
 
void SetClosedCaptionsDispatcher (CYIClosedCaptionsDispatcher *pDispatcher)
 
CYIClosedCaptionsDispatcher * GetClosedCaptionsDispatcher () const
 
const glm::ivec2 & GetSize () const
 
void SetSize (const glm::ivec2 &videoSize)
 

Protected Member Functions

 CYIVideoSurfaceTexture (Capabilities capabilities=Capabilities::None)
 
const std::shared_ptr< CYIMaterial > & GetMaterial () const
 
- Protected Member Functions inherited from CYIVideoSurface
 CYIVideoSurface (Capabilities capabilities)
 
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 {
  Capabilities::None = 0x00,
  Capabilities::RenderToTexture = 0x01,
  Capabilities::MultipleViews = 0x02,
  Capabilities::Translate = 0x04,
  Capabilities::Scale = 0x08,
  Capabilities::FreeTransform = 0x10,
  Capabilities::Opacity = 0x20
}
 
- Public Attributes inherited from CYIVideoSurface
CYISignal< const glm::ivec2 & > SizeChanged
 

Constructor & Destructor Documentation

◆ CYIVideoSurfaceTexture()

CYIVideoSurfaceTexture::CYIVideoSurfaceTexture ( Capabilities  capabilities = Capabilities::None)
protected

The default value will result in CYIVideoSurface::Capabilities::RenderToTexture, CYIVideoSurface::Capabilities::MultipleViews, CYIVideoSurface::Capabilities::Translate, CYIVideoSurface::Capabilities::Scale, CYIVideoSurface::Capabilities::FreeTransform, and CYIVideoSurface::Capabilities::Opacity.

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

Member Function Documentation

◆ Clear()

void CYIVideoSurfaceTexture::Clear ( )

Clears the contents of the video surface texture to black.

Note
Surface must be initialized by calling Init before attemtping to clear.

◆ GetMaterial()

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

◆ Init()

virtual void CYIVideoSurfaceTexture::Init ( )
overridevirtual

Will call InitializeMaterial and InitializeTexture.

Reimplemented from CYIVideoSurface.

Friends And Related Function Documentation

◆ CYIAbstractVideoPlayer

friend class CYIAbstractVideoPlayer
friend

◆ CYIVideoSurfaceView

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