SetVRAMPages

Sets contiguous pages of VRAM to a specified value.

Synopsis

Err SetVRAMPages (Item ioreq,void *dest,int32 value,int32 numpages,int32 mask)

Description

This convenience routine allows one or more pages of VRAM, referred to by the dest argument, to be set to the specified value. The number of VRAM pages set is controlled by the numPages argument. Pages can be set to any value, using the immediate Flashwrite mode in the VRAM. As expected, it is very fast.

This call uses the SPORT device to do the transfer. It takes effect immediately; there is no implicit wait for the next VBlank to occur.

Arguments

ioreq: Item number of the I/O request.

dest: Pointer to the first byte of the first page of the destination VRAM.

value: 32-bit value to be written to the VRAM pages.

numpages: Number of destination pages to receive the copy of the source page.

mask: Write mask, which controls which bits of the source get copied to the destination.

Return Value

The call returns a non-negative value if successful or an error code (a negative value) if an error occurs.

Notes

The use of a mask value other than all 1s (0xFFFFFFFF) is discouraged. Future systems may not support this feature in a performance-conscious manner.

Implementation

Convenience call implemented in graphics.lib V20.

Associated Files

graphics.h, graphics.lib