fg_vbfree()

Win32 DirectX Fastgraph/Light

Prototype

void fg_vbfree (int handle);

Sub fg_vbfree (ByVal handle As Long)

procedure fg_vbfree (handle : integer);

Description

The fg_vbfree() function releases a virtual buffer's handle and frees the memory allocated to the virtual buffer. It is usually called in the WM_DESTROY message handler.

Parameters

handle is the handle that references the virtual buffer to free. Its value must be a valid virtual buffer handle and must not reference the active virtual buffer. If handle is negative and no virtual buffer is active, fg_vbfree() frees all virtual buffers.

Return value

none

Restrictions

You should use fg_vbfree() only with virtual buffers created with fg_vballoc().

This function has no effect if handle references the active virtual buffer.

See also

fg_vballoc(), fg_vbfin()

Examples

First and nearly all the other example programs use this function.