osViGetCurrentField [Function]

Function

osViGetCurrentField

Gets the VI's current field number

Syntax

#include <ultra64.h>        /* os.h */
u32 osViGetCurrentField(void);

Arguments

None.

Return Value

Field number (0 or 1)

Description

Returns the field number currently being accessed by the VI. In interlace mode, either an even number (0) or an odd number (1) will be returned as the current field number. In non-interlace mode, an even number (0) will always be returned. In interlace mode, one screen is displayed with two scans, but it is possible with this function to determine whether the first scan or the second scan is currently under way.

See Also

osViGetCurrentFramebuffer, osViGetCurrentLine, osViGetCurrentMode, osViGetNextFramebuffer, and osViSwapBuffer

Revision History

02/01/99 Completely rewritten.