Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CSlideShowPic Class Reference

#include <SlideShowPicture.h>

Classes

struct  TRANSITION
 

Public Types

enum  DISPLAY_EFFECT {
  EFFECT_NONE = 0 , EFFECT_FLOAT , EFFECT_ZOOM , EFFECT_RANDOM ,
  EFFECT_PANORAMA , EFFECT_NO_TIMEOUT
}
 
enum  TRANSITION_EFFECT {
  TRANSITION_NONE = 0 , FADEIN_FADEOUT , CROSSFADE , TRANSITION_ZOOM ,
  TRANSITION_ROTATE
}
 

Public Member Functions

 CSlideShowPic ()
 
 ~CSlideShowPic ()
 
void SetTexture (int iSlideNumber, CBaseTexture *pTexture, DISPLAY_EFFECT dispEffect=EFFECT_RANDOM, TRANSITION_EFFECT transEffect=FADEIN_FADEOUT)
 
void UpdateTexture (CBaseTexture *pTexture)
 
bool IsLoaded () const
 
void UnLoad ()
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions)
 
void Render ()
 
void Close ()
 
void Reset (DISPLAY_EFFECT dispEffect=EFFECT_RANDOM, TRANSITION_EFFECT transEffect=FADEIN_FADEOUT)
 
DISPLAY_EFFECT DisplayEffect () const
 
bool DisplayEffectNeedChange (DISPLAY_EFFECT newDispEffect) const
 
bool IsStarted () const
 
bool IsFinished () const
 
bool DrawNextImage () const
 
int GetWidth () const
 
int GetHeight () const
 
void Keep ()
 
bool StartTransition ()
 
int GetTransitionTime (int iType) const
 
void SetTransitionTime (int iType, int iTime)
 
int SlideNumber () const
 
void Zoom (float fZoomAmount, bool immediate=false)
 
void Rotate (float fRotateAngle, bool immediate=false)
 
void Pause (bool bPause)
 
void SetInSlideshow (bool slideshow)
 
void SetOriginalSize (int iOriginalWidth, int iOriginalHeight, bool bFullSize)
 
bool FullSize () const
 
int GetOriginalWidth ()
 
int GetOriginalHeight ()
 
void Move (float dX, float dY)
 
float GetZoom () const
 

Public Attributes

bool m_bIsComic
 
bool m_bCanMoveHorizontally
 
bool m_bCanMoveVertically
 

Member Enumeration Documentation

◆ DISPLAY_EFFECT

Enumerator
EFFECT_NONE 
EFFECT_FLOAT 
EFFECT_ZOOM 
EFFECT_RANDOM 
EFFECT_PANORAMA 
EFFECT_NO_TIMEOUT 

◆ TRANSITION_EFFECT

Enumerator
TRANSITION_NONE 
FADEIN_FADEOUT 
CROSSFADE 
TRANSITION_ZOOM 
TRANSITION_ROTATE 

Constructor & Destructor Documentation

◆ CSlideShowPic()

CSlideShowPic::CSlideShowPic ( )

◆ ~CSlideShowPic()

CSlideShowPic::~CSlideShowPic ( )

Member Function Documentation

◆ Close()

void CSlideShowPic::Close ( void  )

◆ DisplayEffect()

DISPLAY_EFFECT CSlideShowPic::DisplayEffect ( ) const
inline

◆ DisplayEffectNeedChange()

bool CSlideShowPic::DisplayEffectNeedChange ( DISPLAY_EFFECT  newDispEffect) const

◆ DrawNextImage()

bool CSlideShowPic::DrawNextImage ( ) const
inline

◆ FullSize()

bool CSlideShowPic::FullSize ( ) const
inline

◆ GetHeight()

int CSlideShowPic::GetHeight ( ) const
inline

◆ GetOriginalHeight()

int CSlideShowPic::GetOriginalHeight ( )

◆ GetOriginalWidth()

int CSlideShowPic::GetOriginalWidth ( )

◆ GetTransitionTime()

int CSlideShowPic::GetTransitionTime ( int  iType) const

◆ GetWidth()

int CSlideShowPic::GetWidth ( ) const
inline

◆ GetZoom()

float CSlideShowPic::GetZoom ( ) const
inline

◆ IsFinished()

bool CSlideShowPic::IsFinished ( ) const
inline

◆ IsLoaded()

bool CSlideShowPic::IsLoaded ( ) const
inline

◆ IsStarted()

bool CSlideShowPic::IsStarted ( ) const
inline

◆ Keep()

void CSlideShowPic::Keep ( )

◆ Move()

void CSlideShowPic::Move ( float  dX,
float  dY 
)

◆ Pause()

void CSlideShowPic::Pause ( bool  bPause)

◆ Process()

void CSlideShowPic::Process ( unsigned int  currentTime,
CDirtyRegionList dirtyregions 
)
Todo:
change m_displayEffect != EFFECT_NO_TIMEOUT to whether we're running the slideshow

◆ Render()

void CSlideShowPic::Render ( void  )

◆ Reset()

void CSlideShowPic::Reset ( DISPLAY_EFFECT  dispEffect = EFFECT_RANDOM,
TRANSITION_EFFECT  transEffect = FADEIN_FADEOUT 
)

◆ Rotate()

void CSlideShowPic::Rotate ( float  fRotateAngle,
bool  immediate = false 
)

◆ SetInSlideshow()

void CSlideShowPic::SetInSlideshow ( bool  slideshow)

◆ SetOriginalSize()

void CSlideShowPic::SetOriginalSize ( int  iOriginalWidth,
int  iOriginalHeight,
bool  bFullSize 
)

◆ SetTexture()

void CSlideShowPic::SetTexture ( int  iSlideNumber,
CBaseTexture pTexture,
DISPLAY_EFFECT  dispEffect = EFFECT_RANDOM,
TRANSITION_EFFECT  transEffect = FADEIN_FADEOUT 
)

◆ SetTransitionTime()

void CSlideShowPic::SetTransitionTime ( int  iType,
int  iTime 
)

◆ SlideNumber()

int CSlideShowPic::SlideNumber ( ) const
inline

◆ StartTransition()

bool CSlideShowPic::StartTransition ( )

◆ UnLoad()

void CSlideShowPic::UnLoad ( )
inline

◆ UpdateTexture()

void CSlideShowPic::UpdateTexture ( CBaseTexture pTexture)

◆ Zoom()

void CSlideShowPic::Zoom ( float  fZoomAmount,
bool  immediate = false 
)

Member Data Documentation

◆ m_bCanMoveHorizontally

bool CSlideShowPic::m_bCanMoveHorizontally

◆ m_bCanMoveVertically

bool CSlideShowPic::m_bCanMoveVertically

◆ m_bIsComic

bool CSlideShowPic::m_bIsComic

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