vertex_freeze

This function can be used to "freeze" a vertex buffer.

A frozen vertex buffer is stored in VRAM and becomes read-only, meaning that if you need to change it, you'd have to delete the whole buffer and re-create it. Because it resides in VRAM, a frozen vertex buffer can be submitted to the shader faster than a normal, dynamic buffer. It is recommended for those effects that require an unchanging custom primitive for the duration of a level or the game.

The function will return 0 on successfully freezing the specified vertex buffer, however if it failed for any reason, it will return -1.

Syntax:

vertex_freeze(buffer);

Returns:

Real (0 for success, -1 for failure)

Example:

Create Event

vertex_freeze(vbuff);

The above code will freeze the given vertex buffer in the Create event, so it can be used as a "static" buffer in other events for faster access.