Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 1

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 1

Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 8

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 8

PgGetLayerCaps()

Query the capabilities of a layer

Synopsis:

int PgGetLayerCaps( int layer, 
                    int format_index,
                    PgLayerCaps_t *const caps );

Arguments:

layer
The layer index, which must be 0 or greater.
format_index
The format index, which must be 0 or greater.
caps
A pointer to a PgLayerCaps_t structure that the function fills with the layer capabilities. Any existing content of the structure is discarded.

This argument must not be NULL.

Library:

ph

Description:

PgGetLayerCaps() queries the capabilities of the given layer, in the given format. You can use the format_index to iterate through all of the available layer formats. An error is returned when format_index exceeds the number of supported formats.


Note: You must target this function at a device by calling PdSetTargetDevice().

Returns:

0
Success.
-1
An error occurred (errno is set).

Errors:

EFAULT
The caps argument is NULL.
EINVAL
The layer index is invalid, or the format_index if greater than the number of formats.
ENXIO
The layer doesn't exist.
EOPNOTSUPP
The driver doesn't support layers.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PdSetTargetDevice(), PgLayerCaps_t

Layers in the Raw Drawing and Animation chapter of the Photon Programmer's Guide


Warning: main(/www/www/htdocs/style/footer.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 171

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/footer.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pg/pggetlayercaps.html on line 171