PtSurfaceExtent(), PtSurfaceExtentById()

Calculate the extent of a control surface

Synopsis:

PhRect_t *PtSurfaceExtent(
             PtWidget_t *widget,
             PtSurface_t const *surface,
             PhRect_t *extent );

PhRect_t *PtSurfaceExtentById(
             PtWidget_t *widget,
             unsigned char surface_id,
             PhRect_t *extent );

Library:

ph

Description:

These functions calculate the extent of a control surface belonging to a given widget. They differ in how they identify the control surface:

PtSurfaceExtent()

Uses the surface argument, which points to a PtSurface_t structure that describes the control surface. This pointer must not be NULL.

PtSurfaceExtentById()

Searches the control surfaces belonging to the widget for the one with an ID of surface_id.

The extent argument points to a PhRect_t structure in which the result is stored.

Returns:

The same pointer as extent. PtSurfaceExtentById() returns NULL if it can't find the control surface with the given ID.

Classification:

Photon

See also:

PhRect_t, PtCalcSurface(), PtCalcSurfaceByAction(), PtCalcSurfaceById(), PtSurfaceCalcBoundingBox(), PtSurfaceCalcBoundingBoxById(), PtSurfaceRect(), PtSurfaceRectById()

Control Surfaces chapter of the Photon Programmer's Guide