fg_clipmask() (legacy function)

Win32 DirectX Fastgraph/Light

Prototype

void fg_clipmask (void *bitmap, int runs, int width);

Sub fg_clipmask (bitmap() As Any, ByVal runs As Long, ByVal width As Long)

procedure fg_clipmask (var bitmap; runs, width : integer);

Description

The fg_clipmask() legacy function displays a masking map, with clipping. The masking map will be positioned so that its lower left corner is at the graphics cursor position.

Parameters

bitmap is the name of the array containing the masking map. The masking map is a series of alternating "protect" and "zero" pixel runs. The "protect" runs leave the corresponding virtual buffer pixels unchanged, while the "zero" runs set them to color zero. The length of each run must be between 0 and 255.

runs is the number of pixel runs in the masking map.

width is the masking map width in pixels.

Return value

none

Restrictions

none

Replaced by

256-color bitmap functions