PtInsertSurface(), PtInsertSurfaceById()

Insert a control surface in front of or behind another

Synopsis:

int PtInsertSurface( PtWidget_t *widget,
                     PtSurface_t *surface,
                     unsigned char brother_id,
                     int behind );

int PtInsertSurfaceById( PtWidget_t *widget,
                         unsigned char surface_id,
                         unsigned char brother_id,
                         int behind );

Library:

ph

Description:

These functions change a surface's z coordinate by inserting the surface in front of or behind another surface. They differ in how they identify the control surface:

PtInsertSurface()

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

PtInsertSurfaceById()

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

The widget argument specifies the widget owning the specified surfaces. The brother_id argument specifies the numerical ID of the surface to position relative to, and the behind argument specifies how to position the surface:

0

The surface is positioned in front of its new brother.

Nonzero

The surface is positioned behind.

Returns:

0

Success.

-1

One or both of the specified surfaces couldn't be found.

Classification:

Photon

See also:

PtSurfaceBrotherBehind(), PtSurfaceBrotherInFront(), PtSurfaceInBack(), PtSurfaceInFront(), PtSurfaceToBack(), PtSurfaceToBackById(), PtSurfaceToFront(), PtSurfaceToFrontById()

Control Surfaces chapter of the Photon Programmer's Guide