video.h File Reference

VIDEO subsystem. More...

#include <gctypes.h>
#include "gx_struct.h"
#include "video_types.h"

Typedefs
typedef void(*	VIPositionCallback) (u32 posX, u32 posY)
typedef void(*	VIRetraceCallback) (u32 retraceCnt)
	function pointer typedef for the user's retrace callback More...

Functions
void	VIDEO_ClearFrameBuffer (GXRModeObj *rmode, void *fb, u32 color)
	Clear the given framebuffer. More...
void	VIDEO_Configure (GXRModeObj *rmode)
	Configure the VI with the given render mode object. More...
void	VIDEO_Flush (void)
	Flush the shadow registers to the drivers video registers. More...
void *	VIDEO_GetCurrentFramebuffer (void)
u32	VIDEO_GetCurrentLine (void)
	Get current video line. More...
u32	VIDEO_GetCurrentTvMode (void)
	Get current configured TV mode. More...
u32	VIDEO_GetFrameBufferSize (GXRModeObj *rmode)
u32	VIDEO_GetNextField (void)
	Get the next field in DS mode. More...
void *	VIDEO_GetNextFramebuffer (void)
GXRModeObj *	VIDEO_GetPreferredMode (GXRModeObj *mode)
u32	VIDEO_GetVideoScanMode (void)
	Get video scan mode. This function returns 0 when interlaced, 1 when non interlaced and 2 when progressive. More...
u32	VIDEO_HaveComponentCable (void)
	Check for a component cable. This function returns 1 when a Component (YPbPr) cable is connected. More...
void	VIDEO_Init (void)
	Initializes the VIDEO subsystem. This call should be done in the early stages of your main() More...
void	VIDEO_SetBlack (bool black)
	Blackout the VIDEO interface. More...
void	VIDEO_SetNextFramebuffer (void *fb)
	Set the framebuffer for the next VI register update. More...
void	VIDEO_SetNextRightFramebuffer (void *fb)
	Set the right framebuffer for the next VI register update. This is used for 3D Gloves for instance. More...
VIRetraceCallback	VIDEO_SetPostRetraceCallback (VIRetraceCallback callback)
	Set the Post-Retrace callback function. This function is called within the video interrupt handler after the VI registers are updated. More...
VIRetraceCallback	VIDEO_SetPreRetraceCallback (VIRetraceCallback callback)
	Set the Pre-Retrace callback function. This function is called within the video interrupt handler before the VI registers will be updated. More...
void	VIDEO_WaitVSync (void)
	Wait on the next vertical retrace. More...

Detailed Description

VIDEO subsystem.

Typedef Documentation

VIRetraceCallback

void(* VIRetraceCallback)(u32 retraceCnt)

function pointer typedef for the user's retrace callback

Parameters

[in]

retraceCnt

current retrace count

Function Documentation

VIDEO_ClearFrameBuffer()

void VIDEO_ClearFrameBuffer	(	GXRModeObj *	rmode,
		void *	fb,
		u32	color
	)

Clear the given framebuffer.

Parameters

[in]	rmode	pointer to a GXRModeObj, specifying the mode.
[in]	fb	pointer to the startaddress of the framebuffer to clear.
[in]	color	YUYUV value to use for clearing.

Returns

none

VIDEO_Configure()

void VIDEO_Configure

(

GXRModeObj *

rmode

)

Configure the VI with the given render mode object.

Parameters

[in]

rmode

pointer to the video/render mode configuration.

Returns

none

VIDEO_Flush()

void VIDEO_Flush

(

void

)

Flush the shadow registers to the drivers video registers.

Returns

none

VIDEO_GetCurrentLine()

u32 VIDEO_GetCurrentLine

(

void

)

Get current video line.

Returns

linenumber

VIDEO_GetCurrentTvMode()

u32 VIDEO_GetCurrentTvMode

(

void

)

Get current configured TV mode.

Returns

tvmode

VIDEO_GetNextField()

u32 VIDEO_GetNextField

(

void

)

Get the next field in DS mode.

Returns

field

VIDEO_GetVideoScanMode()

u32 VIDEO_GetVideoScanMode

(

void

)

Get video scan mode. This function returns 0 when interlaced, 1 when non interlaced and 2 when progressive.

Returns

0 when interlaced, 1 when non interlaced and 2 when progressive

VIDEO_HaveComponentCable()

u32 VIDEO_HaveComponentCable

(

void

)

Check for a component cable. This function returns 1 when a Component (YPbPr) cable is connected.

Returns

1 if a component cable is connected, 0 otherwise

VIDEO_Init()

void VIDEO_Init

(

void

)

Initializes the VIDEO subsystem. This call should be done in the early stages of your main()

Returns

none

VIDEO_SetBlack()

void VIDEO_SetBlack

(

bool

black

)

Blackout the VIDEO interface.

Parameters

[in]

black

Boolean flag to determine whether to blackout the VI or not.

Returns

none

VIDEO_SetNextFramebuffer()

void VIDEO_SetNextFramebuffer

(

void *

fb

)

Set the framebuffer for the next VI register update.

Returns

none

VIDEO_SetNextRightFramebuffer()

void VIDEO_SetNextRightFramebuffer

(

void *

fb

)

Set the right framebuffer for the next VI register update. This is used for 3D Gloves for instance.

Returns

none

VIDEO_SetPostRetraceCallback()

VIRetraceCallback VIDEO_SetPostRetraceCallback

(

VIRetraceCallback

callback

)

Set the Post-Retrace callback function. This function is called within the video interrupt handler after the VI registers are updated.

Parameters

[in]

callback

pointer to the callback function which is called at post-retrace.

Returns

Old post-retrace callback or NULL

VIDEO_SetPreRetraceCallback()

VIRetraceCallback VIDEO_SetPreRetraceCallback

(

VIRetraceCallback

callback

)

Set the Pre-Retrace callback function. This function is called within the video interrupt handler before the VI registers will be updated.

Parameters

[in]

callback

pointer to the callback function which is called at pre-retrace.

Returns

Old pre-retrace callback or NULL

VIDEO_WaitVSync()

void VIDEO_WaitVSync

(

void

)

Wait on the next vertical retrace.

Returns

none