graphics_comment


bool graphics_comment(handle device,
                      unsigned size,
                      const byte* comment)

This function issues a graphics comment.

Parameters

handle device

The handle of the device context to which the graphics comment is passed.

unsigned size

The length of the graphics comments specified by the next parameter.

const byte* comment

A pointer to the comment data.

Return

bool

true The function succeeded.
false The function was unsuccessful.

Notes

A comment can contain any form of application defined data. A comment begins with an application signature (unsigned integer), followed by the data.

There are several publicly defined comments. Public comments begin with the signature:

graphics_comment::Identifier.

Standard public comments include: