PtHideSurface(), PtHideSurfaceById()

Hide a control surface

Synopsis:

int PtHideSurface( PtWidget_t *widget,
                   PtSurface_t *surface );

int PtHideSurfaceById( PtWidget_t *widget,
                       uchar_t surface_id );

Library:

ph

Description:

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

PtHideSurface()

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

PtHideSurfaceById()

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

Hidden surfaces don't draw and aren't included in event processing.

Returns:

0

Success.

-1

The specified surface couldn't be found or was already hidden.

Classification:

Photon

See also:

PtHideSurfaceByAction(), PtShowSurface(), PtShowSurfaceByAction(), PtShowSurfaceById(), PtSurfaceIsHidden(), PtSurfaceIsShown()

Control Surfaces chapter of the Photon Programmer's Guide