PhRegionChange()

Change the definition of a region

Synopsis:

int PhRegionChange( unsigned long fields,
                    unsigned long flags,
                    PhRegion_t const *info,
                    PhRect_t const *rect,
                    void const *data );

Description:

This function changes the definition of the region specified by info->rid. The fields argument describes which fields in the info structure are to be changed - for more information, see PhRegionOpen().

The rect argument points to the rectangle associated with the region, and data points to data associated with the region. If you don't specify the region's rectangle and data in the fields argument, you can set rect and data to NULL.

The data consists of one or more PhRegionDataHdr_t structures, each followed immediately by the appropriate type of data. This data is merged into any existing region data, replacing the blocks of the same types as given in data.

The flags argument controls whether or not an expose event will be emitted to this region, when necessary. You can OR the following into flags:

Ph_EXPOSE_REGION

If part of the region becomes exposed, send a Ph_EV_EXPOSE event to the region.

Ph_EXPOSE_FAMILY

If part of the region becomes exposed, send a Ph_EV_EXPOSE event to the region's descendants.

Returns:

0

Successful completion.

-1

An error occurred.

Classification:

Photon

See also:

PhRegion_t, PhRegionClose(), PhRegionDataHdr_t, PhRegionOpen()