video.h File Reference

VIDEO subsystem. More...

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

Typedefs

typedef void(*) VIRetraceCallback (u32 retraceCnt)
 function pointer typedef for the user's retrace callback

Functions

void VIDEO_Init ()
 Initializes the VIDEO subsystem. This call should be done in the early stages of your main().
void VIDEO_Flush ()
 Flush the shadow registers to the drivers video registers.
void VIDEO_SetBlack (boolean black)
 Blackout the VIDEO interface.
u32 VIDEO_GetNextField ()
 Get the next field in DS mode.
u32 VIDEO_GetCurrentLine ()
 Get current video line.
u32 VIDEO_GetCurrentTvMode ()
 Get current configured TV mode.
void VIDEO_Configure (GXRModeObj *rmode)
 Configure the VI with the given render mode object.
void VIDEO_ClearFrameBuffer (GXRModeObj *rmode, void *fb, u32 color)
 Clear the given framebuffer.
void VIDEO_WaitVSync (void)
 Wait on the next vertical retrace.
void VIDEO_SetNextFramebuffer (void *fb)
 Set the framebuffer for the next VI register update.
void VIDEO_SetNextRightFramebuffer (void *fb)
 Set the right framebuffer for the next VI register update. This is used for 3D Gloves for instance.
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.
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.


Detailed Description

VIDEO subsystem.


Typedef Documentation

void(* VIRetraceCallback)(u32 retraceCnt)

function pointer typedef for the user's retrace callback

Parameters:
[in] retraceCnt current retrace count


Function Documentation

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

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

void VIDEO_Flush (  ) 

Flush the shadow registers to the drivers video registers.

Returns:
none

u32 VIDEO_GetCurrentLine (  ) 

Get current video line.

Returns:
linenumber

u32 VIDEO_GetCurrentTvMode (  ) 

Get current configured TV mode.

Returns:
tvmode

u32 VIDEO_GetNextField (  ) 

Get the next field in DS mode.

Returns:
field

void VIDEO_Init (  ) 

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

Returns:
none

void VIDEO_SetBlack ( boolean  black  ) 

Blackout the VIDEO interface.

Parameters:
[in] black Boolean flag to determine whether to blackout the VI or not.
Returns:
none

void VIDEO_SetNextFramebuffer ( void *  fb  ) 

Set the framebuffer for the next VI register update.

Returns:
none

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

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

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

void VIDEO_WaitVSync ( void   ) 

Wait on the next vertical retrace.

Returns:
none


Generated on Sun Feb 4 18:14:34 2007 for libOGC by  doxygen 1.4.7