PgLayerCaps_t

Capabilities for a layer

Synopsis:

typedef struct {
    unsigned int    format;
    long            owner;

    unsigned int    caps;
    unsigned int    alpha_caps;
    unsigned int    alpha_combine_caps;
    unsigned int    chroma_caps;

    int     max_data_width;
    int     max_data_height;

    int     max_src_width;
    int     max_src_height;

    int     max_dst_width;
    int     max_dst_height;
    int     min_dst_width;
    int     min_dst_height;

    int     max_x_scale;
    int     max_y_scale;
    int     min_x_scale;
    int     min_y_scale;
    int     format_flags;

    unsigned int    reserved[3];
} PgLayerCaps_t;

Description:

The PgLayerCaps_t structure describes the capabilities of a layer. To fill in this structure for a layer, call PgGetLayerCaps(). To set the capabilities, call PgSetLayerArg().

The members of the PgLayerCaps_t structure include:

format
The layer format that corresponds to the format index that you pass to PgGetLayerCaps(); one of:
owner
The Photon client ID of the owner, if the surface is locked.
caps
General capabilities; a combination of the following:
alpha_caps
Alpha capabilities. Only global and per-pixel alpha blending are currently supported. Alpha maps aren't supported for blending between layers.
alpha_combine_caps
Alpha combine capabilities.
chroma_caps
Chroma key capabilities:
max_data_width, max_data_height
The maximum size of a layer surface, in pixels.
max_src_width, max_src_height
The maximum size of the source viewport, in pixels.
max_dst_width, max_dst_height
The maximum size of the destination viewport, in pixels.
min_dst_width, min_dst_height
The minimum size of the destination viewport, in pixels.
max_x_scale
The maximum scaling factor for scaling up in the horizontal direction:

Values less than 1 are invalid.

max_y_scale
The maximum scaling factor for scaling up in the vertical direction:

Values less than 1 are invalid.

min_x_scale
The maximum scaling factor for scaling down in the horizontal direction:

Values less than 1 are invalid.

min_y_scale
The maximum scaling factor for scaling down in the vertical direction:

Values less than 1 are invalid.

format_flags
Flags that specify the packing or byte order of the format member; this can be 0, or one of the following:

Classification:

Photon

See also:

PgGetLayerCaps(), PgSetLayerArg(), PhImage_t

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