Photon microGUI widgets library 0.6.0
PhImage_t Struct Reference
Photon native functions and types

#include <PhWidgetsNativeTypes.h>

Detailed Description

Data and characteristics of an image.

The PhImage_t structure describes the data and characteristics of an PhWidgets::Drawing::Image. When you give an image to a PhWidgets::Label subclass widget, this is the structure you must provide. The members include at least:

Members

‍int type The graphic type; see PhWidgets::Drawing::ImageType

‍unsigned long image_tag The image-data tag, a cyclic redundancy check (CRC) that's used extensively by phrelay (see the QNX Neutrino Utilities Reference) to cache images.

‍int bpl The number of bytes in each line of the image.

‍PhDim_t size A PhDim_t structure that defines the size of the image.

‍unsigned long palette_tag The palette-data tag.

‍int colors The number of colors in the image.

‍PgAlpha_t *alpha The image alpha map that's used if the source alpha map option is enabled. Members are undocumented.

‍PgColor_t transparent The color to mask out when drawing.

‍char flags The image flags. The valid bits are:

  • Ph_RELEASE_IMAGE — free the image data.
  • Ph_RELEASE_PALETTE — free the palette data.
  • Ph_RELEASE_TRANSPARENCY_MASK — free the transparency mask bitmap.
  • Ph_RELEASE_GHOST_BITMAP — free the bitmap used for ghosting.
  • Ph_RELEASE_IMAGE_ALL — free all the above.
  • Ph_USE_TRANSPARENCY — make the image transparent by using the color specified by the transparent member as the key for a chroma operation.

A widget automatically frees the memory pointed to by the PhImage_t members if these bits are set.

‍char ghost_bpl The number of bytes per line for the ghosting bitmap.

‍char *ghost_bitmap
A pointer to the transparency mask for ghosting an image. The leftmost pixel corresponds to the top bit of the first byte in the mask.

‍int mask_bpl
The number of bytes per line for the transparency mask.

‍char *mask_bm
A pointer to the transparency mask. The leftmost pixel corresponds to the top bit of the first byte in the mask.

‍PgColor_t *palette
The image palette.

‍char *image
The image pixel data.

Remarks
Use PhWidgets::Drawing::Image to manipulate PhWidgets::Label::Image property and widget image resources as general.
See also
The documentation for this struct was generated from the following file: