PSPixelMap Struct Reference

Describes a block of pixels for display purposes. More...

#include <PIGeneral.h>


Data Fields

int32 version
 Set to 1.
VRect bounds
 The bounds for the pixel map.
int32 imageMode
 The mode for the image data.
int32 rowBytes
 The offset from one row to the next of pixels.
int32 colBytes
 The offset from one column to the next of pixels.
int32 planeBytes
 The offset from one plane of pixels to the next.
void * baseAddr
 The address of the byte value for the first plane of the top left pixel.
New in version 1
PSPixelMaskmat
 A pixel mask to use for matting correction.
PSPixelMaskmasks
 A pointer to a chain of PSPixelMasks that are multiplied together (with the possibility of inversion) to establish which areas of the image are transparent and should have the checkerboard displayed.
int32 maskPhaseRow
 The phase of the checkerboard with respect to the top left corner of the /c PSPixelMap.
int32 maskPhaseCol
 The phase of the checkerboard with respect to the top left corner of the /c PSPixelMap.
New in version 2
PSPixelOverlaypixelOverlays
unsigned32 colorManagementOptions
 Options for color management.

Detailed Description

Describes a block of pixels for display purposes.

Used in DisplayPixelsProc. Version 1 10/14/1997 Version 2 03/22/1999


Field Documentation

Set to 1.

Future versions of Photoshop may support additional parameters and will support higher version numbers for PSPixelMap.

The bounds for the pixel map.

The mode for the image data.

The supported modes are grayscale, RGB, CMYK, and Lab. See Image Modes for values. Additionally, if the mode of the document being processed is DuotoneMode or IndexedMode, you can pass plugInModeDuotone or plugInModeIndexedColor.

The offset from one row to the next of pixels.

The offset from one column to the next of pixels.

The offset from one plane of pixels to the next.

In RGB, the planes are ordered red, green, blue; in CMYK, the planes are ordered cyan, magenta, yellow, black; in Lab, the planes are ordered L, a, b.

The address of the byte value for the first plane of the top left pixel.

A pixel mask to use for matting correction.

Can be specified in all modes except indexed color. For example, if you have white matted data to display, you can specify a mask in this field to remove the white fringe. This field points to a PSPixelMask structure with a maskDescription that indicates what type of matting needs to be compensated for. If this field is NULL, Photoshop performs no matting compensation. If the masks are chained, only the first mask in the chain is used.

A pointer to a chain of PSPixelMasks that are multiplied together (with the possibility of inversion) to establish which areas of the image are transparent and should have the checkerboard displayed.

/c kSimplePSMask, /c kBlackMatPSMask, /c kWhiteMatPSMask, and /c kGrayMatPSMask all operate such that 255=opaque and 0=transparent. /c kInvertPSMask has 255=transparent and 0=opaque.

The phase of the checkerboard with respect to the top left corner of the /c PSPixelMap.

The phase of the checkerboard with respect to the top left corner of the /c PSPixelMap.

Options for color management.

See ColorManagement


The documentation for this struct was generated from the following file: