cl_cinematic.h File Reference

Header file for cinematics. More...

#include "../client.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_s
Typedefs
typedef struct cinematic_s	cinematic_t
Enumerations
enum	{ CINEMATIC_TYPE_ROQ, CINEMATIC_TYPE_OGM }
enum	cinStatus_t { CIN_STATUS_NONE, CIN_STATUS_PLAYING, CIN_STATUS_PAUSE }
Functions
void	CIN_StopCinematic (cinematic_t *cin)
void	CIN_PlayCinematic (cinematic_t *cin, const char *name)
void	CIN_SetParameters (cinematic_t *cin, int x, int y, int w, int h, int cinStatus, qboolean 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.

---

Typedef Documentation

typedef struct cinematic_s cinematic_t

---

Enumeration Type Documentation

anonymous enum

Enumerator:

CINEMATIC_TYPE_ROQ
CINEMATIC_TYPE_OGM

Definition at line 31 of file cl_cinematic.h.

enum cinStatus_t

Enumerator:

CIN_STATUS_NONE	not playing
CIN_STATUS_PLAYING
CIN_STATUS_PAUSE

Definition at line 61 of file cl_cinematic.h.

---

Function Documentation

void CIN_Init

(

void

)

Definition at line 116 of file cl_cinematic.c.

References CIN_OGM_Init(), and CIN_ROQ_Init().

Referenced by CL_Init().

void CIN_InitCinematic

(

cinematic_t *

cin

)

Definition at line 33 of file cl_cinematic.c.

Referenced by CIN_StopCinematic(), and UI_VideoNodeInit().

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

See also:

CIN_StopCinematic

Definition at line 81 of file cl_cinematic.c.

References CIN_OGM_PlayCinematic(), CIN_ROQ_PlayCinematic(), CIN_StopCinematic(), Com_Printf(), Com_StripExtension(), FS_CheckFile(), MAX_OSPATH, name, and va().

Referenced by CIN_RunCinematic(), and UI_VideoNodeDrawOverWindow().

void CIN_RunCinematic

(

cinematic_t *

cin

)

See also:

CL_Frame

Definition at line 57 of file cl_cinematic.c.

References CIN_OGM_RunCinematic(), CIN_PlayCinematic(), CIN_ROQ_RunCinematic(), CIN_STATUS_NONE, CIN_StopCinematic(), CINEMATIC_TYPE_OGM, CINEMATIC_TYPE_ROQ, cinematic_s::cinematicType, MAX_QPATH, cinematic_s::name, name, Q_strncpyz(), qtrue, cinematic_s::replay, and cinematic_s::status.

Referenced by UI_VideoNodeDrawOverWindow().

void CIN_SetParameters	(	cinematic_t *	cin,
		int	x,
		int	y,
		int	w,
		int	h,
		int	status,
		qboolean	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 43 of file cl_cinematic.c.

References CIN_STATUS_NONE, cinematic_s::h, cinematic_s::noSound, viddef_t::rx, viddef_t::ry, cinematic_s::status, viddef, cinematic_s::w, cinematic_s::x, and cinematic_s::y.

Referenced by UI_VideoNodeDrawOverWindow().

void CIN_Shutdown

(

void

)

Definition at line 122 of file cl_cinematic.c.

Referenced by CL_Shutdown().

void CIN_StopCinematic

(

cinematic_t *

cin

)

See also:

CIN_PlayCinematic

Definition at line 101 of file cl_cinematic.c.

References CIN_InitCinematic(), CIN_OGM_StopCinematic(), CIN_ROQ_StopCinematic(), CIN_STATUS_NONE, CINEMATIC_TYPE_OGM, CINEMATIC_TYPE_ROQ, cinematic_s::cinematicType, and cinematic_s::status.

Referenced by CIN_PlayCinematic(), CIN_RunCinematic(), and UI_VideoNodeClose().