PgReadScreenSize()

Determine the memory requirements for reading an image from the screen

Synopsis:

unsigned long PgReadScreenSize( PhRect_t *rect );

Library:

ph

Description:

This function determines how much memory is required to store an image that would be generated by a corresponding call to PgReadScreen(). This function is useful only if you plan to allocate an image storage buffer yourself.

The PhRect_t structure pointed to by rect specifies the target area (in absolute Photon coordinates).

---

You must target this function at a specific card by calling PdSetTargetDevice(). PgReadScreenSize() blocks until the operation is complete.

---

Returns:

The number of bytes required to store the image, including palette data (if applicable), or 0 if an error occurred.

Errors:

See PgReadScreen().

Classification:

Photon

See also:

PgReadScreen(), PhRect_t