VISetTrapFilter

Syntax

#include <revolution/vi.h>

void VISetTrapFilter(VIBool filter);

Arguments

filter Specify VI_ENABLE to apply a trap filter onscreen. If VI_DISABLE is specified, a trap filter is not applied onscreen.

Return Values

None.

Description

This function applies a trap filter to the screen when VI_ENABLE is specified.
Once the trap filter has been enabled during a game with VI_ENABLE, the trap filter will continue to function until disabled with VI_DISABLE.

The trap filter affects only composite output. When the trap filter is applied to the screen, cross-color is mitigated, but the entire screen becomes slightly blurred. If a trap filter is not applied to the screen, the edges of the picture are sharper and text is easier to read, but cross-color occurs.

Changes do not take effect until VIFlush is called. See the VIFlush function reference for details on enabling effects.
Note that trap filter is always set to disabled (VI_DISABLE) by VIInit.

See Also

VIFlush, VIInit

Revision History

2006/09/16 Added a note that the trap filter will be set to disabled by VIInit.
2006/05/09 Added entry on the length of time that the trap filter continues to function.
2006/03/01 Initial version.


CONFIDENTIAL