cl_cinematic.h File Reference

Header file for cinematics. More...

#include "../../shared/ufotypes.h"
#include "../../common/filesys.h"

Include dependency graph for cl_cinematic.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	cinematic_t

Enumerations
enum	{ CINEMATIC_NO_TYPE , CINEMATIC_TYPE_ROQ , CINEMATIC_TYPE_OGM }
enum	cinStatus_t { CIN_STATUS_NONE , CIN_STATUS_INVALID , CIN_STATUS_PLAYING , CIN_STATUS_PAUSE }

Functions
void	CIN_OpenCinematic (cinematic_t *cin, const char *name)
	Open a cinematic file and store status to a structure.
void	CIN_CloseCinematic (cinematic_t *cin)
	Close a cinematic, and clean up status and memory.
void	CIN_SetParameters (cinematic_t *cin, int x, int y, int w, int h, int cinStatus, bool noSound)
void	CIN_RunCinematic (cinematic_t *cin)
void	CIN_InitCinematic (cinematic_t *cin)
void	CIN_Init (void)
void	CIN_Shutdown (void)

Detailed Description

Header file for cinematics.

Definition in file cl_cinematic.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
CINEMATIC_NO_TYPE
CINEMATIC_TYPE_ROQ
CINEMATIC_TYPE_OGM

Definition at line 31 of file cl_cinematic.h.

cinStatus_t

enum cinStatus_t

Enumerator
CIN_STATUS_NONE	not playing
CIN_STATUS_INVALID
CIN_STATUS_PLAYING
CIN_STATUS_PAUSE

Definition at line 62 of file cl_cinematic.h.

Function Documentation

CIN_CloseCinematic()

void CIN_CloseCinematic

(

cinematic_t *

cin

)

Close a cinematic, and clean up status and memory.

See also

CIN_PlayCinematic

Definition at line 111 of file cl_cinematic.cpp.

References CIN_InitCinematic(), CIN_OGM_CloseCinematic(), CIN_ROQ_CloseCinematic(), CIN_STATUS_NONE, CINEMATIC_TYPE_OGM, CINEMATIC_TYPE_ROQ, cinematic_t::cinematicType, and cinematic_t::status.

Referenced by CIN_OpenCinematic(), CIN_RunCinematic(), and uiVideoNode::onWindowClosed().

CIN_Init()

void CIN_Init

(

void

)

Definition at line 126 of file cl_cinematic.cpp.

References CIN_OGM_Init(), and CIN_ROQ_Init().

Referenced by CL_Init().

CIN_InitCinematic()

void CIN_InitCinematic

(

cinematic_t *

cin

)

Definition at line 37 of file cl_cinematic.cpp.

References OBJZERO.

Referenced by CIN_CloseCinematic(), and uiVideoNode::onWindowOpened().

CIN_OpenCinematic()

void CIN_OpenCinematic	(	cinematic_t *	cin,
		const char *	fileName )

Open a cinematic file and store status to a structure.

See also

CIN_CloseCinematic

Definition at line 86 of file cl_cinematic.cpp.

References CIN_CloseCinematic(), CIN_OGM_OpenCinematic(), CIN_ROQ_OpenCinematic(), CIN_STATUS_INVALID, Com_Printf(), Com_StripExtension(), FS_CheckFile(), MAX_OSPATH, name, cinematic_t::status, and va().

Referenced by CIN_RunCinematic(), and uiVideoNode::drawOverWindow().

CIN_RunCinematic()

void CIN_RunCinematic

(

cinematic_t *

cin

)

See also

CL_Frame

Definition at line 61 of file cl_cinematic.cpp.

References CIN_CloseCinematic(), CIN_OGM_RunCinematic(), CIN_OpenCinematic(), CIN_ROQ_RunCinematic(), CIN_STATUS_NONE, CINEMATIC_TYPE_OGM, CINEMATIC_TYPE_ROQ, cinematic_t::cinematicType, MAX_QPATH, cinematic_t::name, name, Q_strncpyz(), cinematic_t::replay, and cinematic_t::status.

Referenced by uiVideoNode::drawOverWindow().

CIN_SetParameters()

void CIN_SetParameters	(	cinematic_t *	cin,
		int	x,
		int	y,
		int	w,
		int	h,
		int	status,
		bool	noSound )

See also

UI_Draw

Note

Coordinates should be relative to VID_NORM_WIDTH and VID_NORM_HEIGHT they are normalized inside this function

Definition at line 47 of file cl_cinematic.cpp.

References CIN_STATUS_NONE, cinematic_t::h, cinematic_t::noSound, cinematic_t::status, viddef, cinematic_t::w, cinematic_t::x, and cinematic_t::y.

Referenced by uiVideoNode::drawOverWindow().

CIN_Shutdown()

void CIN_Shutdown

(

void

)

Definition at line 132 of file cl_cinematic.cpp.

Referenced by CL_Shutdown().