|
Adobe Photoshop SDK |
|
FormatRecord Struct Reference This structure is passed to the plug-in module through the parameter block. More...
Detailed DescriptionThis structure is passed to the plug-in module through the parameter block. See Plug-in Entry Point for an explanation of how the host calls a plug-in. Field Documentation
The host now reports zero for the A pointer to the A pointer the the
The maximum number of bytes Photoshop can free up for a plug-in to use. The plug-in can reduce this value during in the handlers for the Format prepare selectors. The The minimum bytes needed in the data fork space to write the file. The plug-in should set this during the estimate sequence of selector calls. See formatSelectorEstimateStart. The maximum bytes allocated in the data fork space to write the file. The plug-in should set this during the estimate sequence of selector calls. See formatSelectorEstimateStart. The minimum bytes needed in resource fork space to write the file. The plug-in should set this during the estimate sequence of selector calls. The maximum bytes allocated in resource fork space to write the file. The plug-in should set this during the estimate sequence of selector calls.
The reference number for the data fork of the file to be read during the read sequence or written during the write sequence. During the options and estimate selector sequences, this field is undefined. In Windows, this is the file handle of the file returned by
During the options and estimate selector sequences, this field is undefined. In Windows, this field is undefined.
Full file specification. This is an array when using the formatSelectorBulkSettings. See fileSpec2.
This is nil under Mac 64, since FSSpecs are not supported. use fileSpec2 instead, which is supported on all platforms The mode of the image being imported (grayscale, RGB Color, and so on). The plug-in should set this field during the formatSelectorReadStart handler. Photoshop sets this field before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart.
The size of the image.
The resolution of the image in bits per pixel per plane. The plug-in should set this field in the formatSelectorReadStart handler. Valid settings are 1, 8, 16, and 32.
The number of channels in the image. For example, if an RGB image without alpha channels is being returned, this field should be set to 3. The plug-in should set this field in the formatSelectorReadStart handler. Photoshop sets this field before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart.
The horizontal resolution of the image in terms of pixels per inch. This is a fixed point number (16 binary digits). Photoshop initializes this field to 72 pixels per inch. The plug-in should set this field in the formatSelectorReadStart handler. Photoshop sets this field before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart.
The vertical resolution of the image in terms of pixels per inch. This is a fixed point number (16 binary digits). Photoshop initializes this field to 72 pixels per inch. The plug-in should set this field in the formatSelectorReadStart handler. Photoshop sets this field before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart.
The image's red color table. If an indexed color mode image is being returned, the plug-in should set this field in the formatSelectorReadStart handler. If an indexed color document is being written, Photoshop sets these fields before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart. The image's green color table. If an indexed color mode image is being returned, the plug-in should set this field in the formatSelectorReadStart handler. If an indexed color document is being written, Photoshop sets these fields before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart. The image's blue color table. If an indexed color mode image is being returned, the plug-in should set this field in the formatSelectorReadStart handler. If an indexed color document is being written, Photoshop sets these fields before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart.
The buffer where image data is or will be stored. The plug-in should return a pointer to this buffer in the start and continue handlers. After the entire image has been processed, the continue selector handlers should set this field to NULL.
The first plane covered by the buffer specified in data. The start and continue selector handlers should set this field. For example, if interleaved RGB data is being used, it should be set to 0.
The first and last planes covered by the buffer specified in The start and continue selector handlers should set this field. For example, if interleaved RGB data is being used, it should be set to 2.
The offset in bytes between columns of data in the buffer. The start and continue selector handlers should set this field. This is usually 1 for non-interleaved data, or
The offset in bytes between rows of data in the buffer. The start and continue selector handlers should set this field.
The offset in bytes between planes of data in the buffers. The start and continue selector handlers should set this field. This field is ignored if Maps plug-in plane (channel) numbers to host plane numbers. The host initializes it to a linear map:
Indicates whether the host supports transposing images during or after reading or before or during writing. When TRUE, the host supports transposing. Photoshop always sets this field to TRUE.
Indicates whether the plug-in needs the image transposed. Initialized by the host to FALSE. If the plug-in wishes to transpose the image, and
The signature of the host, provided by the host. The signature for Photoshop is signature is 8BIM. A pointer to a host-defined callback procedure. May be NULL.
The image modes supported by the host. If the corresponding bit is 1, (where LSB = bit 0), the mode is supported. This field can be used by plug-ins to disable reading unsupported file formats. See Image Modes for supported current modes.
Information kept with the document for reverting or saving; where possible this handle should be used to avoid bringing up an options dialog. Photoshop sets this field to NULL when a format for a file is first created. If this field is defined on a formatSelectorReadStart call, then treat the call as a revert and do not query the user. If it is NULL on the A pointer to the A pointer to the
A handle to a block of data to be stored in the file as image resource data. Photoshop documents can have other properties associated with them besides pixel data. For example, documents typically contain page setup information and pen tool paths. The size of the handle It is only relevant during the estimate sequence when it is provided instead of the actual resource data. Monitor setup information for the host. A pointer to platform specific data. Not used under Mac OS. See PlatformData in PITypes.h. A pointer to the Buffer suite if it is supported by the host, otherwise NULL. A pointer to the Pseudo-Resource suite if it is supported by the host, otherwise NULL. A pointer to the A pointer to the A pointer to the Handle callback suite if it is supported by the host, otherwise NULL.
file type for filtering A pointer to the ColorServices callback if it is supported by the host, otherwise NULL. A pointer to the Valid from continue selector handlers. The Property callback suite. The plug-in needs to dispose of the handle returned for complex properties. The plug-in also maintains ownership of handles for set properties. Image Services callback suite.
The width of the tiles provided by the host. This is the best unit to work with, if possible. Zero if not set.
The height of the tiles provided by the host. This is the best unit to work with, if possible. Zero if not set.
The origin point of the tiling system. Descriptor callback suite.
An error reporting string to return to Photoshop. If the plug-in returns with result=errReportString then this string is displayed as: "Cannot complete operation because " +
Used for read with 16-bit depth only.
PICA basic suite. Provides the mechanism to access all PICA suites.
Plug-in reference used by PICA. If IndexedColor, and < 256, this is the index of the transparent color (for GIF).
Handle containing the ICC profile for the image; NULL if none.
Size of Indicates if the host uses ICC Profiles. Non-zero if the host can accept or export ICC profiles. If this is zero, don't set or dereference
Number of entries in the indexed color table. This should include the transparent index if any. Plug-ins should pad out the color table with black for backward compatibility. A bitmask indicating which color modes are preferred by the host This will be zero if not set. The plug-in is free to ignore the hint (though it is wise to obey the hostModes information). This is an int32 rather than an int16 to allow for future expansion. Indicates whether the host supports conversion after reading; 0 if it does not, -1 if it does. The plug-in can set this field to the index of a color mode and this is treated by the host as a request to automatically convert to that mode. Hosts can ignore this request but they will make the host+plug-in combination appear broken. The preferred size for the image; 0,0 if not set. This is a hint about how big an image the wants. This field uses 32-bit coordinates rather than 16-bit coordinates, to allow for future expansion.
The index of the image; 0 if not set. One indicates the first image, etc. Currently only used for PDF Image extractor. Index of the plane containing transparency information. When writing files: Transparency matting information; 0: no matte, 1: black matte, 2: gray matte, 3: white matte When reading files, indicates how the transparency data should be interpreted with respect to color matting.
Suite for passing pixels through channel ports. The document info for the document being written.
Indicates whether the document is open for preview. Set by the host, the plug-in should make the smallest previewable size if it can. Rotation or flip applied to the image. When reading files, this field lets the plug-in know what rotation and/or flip is applied to the image after opening. This lets the plug-in display any preview images correctly. Lowest two bits are number of 90 degree CW rotations. See Bit masks for the browserRotation field for other flags. This field is also used when requesting a value for the PIFmtPRotate property and when calling the formatSelectorLosslessRotate selector. Indicates whether the host supports 32 bit plug-in API. Indicates whether the plug-in is using the 32-bit fields; set to nonzero by the plug-in if it is. Size of image in 32 bit coordinates, replaces The plug-in should should set this field in the formatSelectorReadStart handler to inform Photoshop of the width and height of the image in pixels. Photoshop sets this field before it calls formatSelectorOptionsStart, formatSelectorEstimateStart, or formatSelectorWriteStart. Rectangle being returned in 32 bit coordinates, replaces The area of the image covered by the buffer specified in Set to a valid format file property to request the value for that property. The requested property value is returned in this field.
Count of files for bulk settings selector. If the bulkMask has the PIFmtBulkModifyListMask bit set, then this field is read/write. Otherwise it is read only.
XMP handle for read and write, only valid when using formatSelectorXMPRead and formatSelectorXMPWrite.
Indicates whether the This error code tells the host to skip this file when processing multiple files. When this flag is set, Read protocol should return an extracted thumbnail without reading the entire file. Indicates if the host calling this from a non-UI thread. Set to TRUE, if so.
Tells the plug-in which features of the bulkFlags array are supported.
Pointer to an array of fileCount 32-bit flags, used for two way information transfer when using the bulk settings and bulk open APIs.
Number of settings presets found.
Handle holding array of UTF-8 encoded preset name handles.
Handle holding array of XMP preset data handles. Checksum of raw conversion settings.
Unicode/FSRef replacement for fileSpec.
On read: Set by plugin in Start to tell host how many layers are in the document. Set by the host prior to calling ReadLayerStart to tell the plugin which layer it is requesting data for. On write: Set by host prior to calling Start to tell plugin how many layers are in the document. Set by the host prior to calling WriteLayerStart to tell the plugin which layer it is sending data for.
A utf16 encoded string that contains the name of the layer On read, this should be set by the plugin before leaving ReadLayerFinish On write, this will be set by the host before calling WriteLayerStart. Data for Plugin Rendered Layers.
Pointer to an array of handles used to pass parameter blocks between the bulk settings and bulk open calls and the corresponding open calls. Before calling the bulk settings or bulk open call, the host should initialize this field to a pointer to a list of "fileCount" NULL Handles. During the bulk settings or bulk open call, if the plug-in decides to request that a file be opened it may allocate a handle to hold some parameters for that file, and set the bulkParams array entry to that handle. When the host then opens the requested files using open calls, it should pass back the parameter block in this same file. (Since only open file is being opened at a time, this is just a pointer to a single handle during this phase). The host is required to free all the parameter block handles.
Set this to true and the new document will be placed as a smart object. For per-layer meta data.
A utf16 encoded string that contains the location of the final file. Use this for reference only. This will give you the parent folder and the name of the final file. Read and write via the fileSpec2 only and not this value.
On read: Set by plug-in to indiate that this layer is a text layer, plug-in must also set textDescriptor On write: Set by host to indiate that this layer is a text layer, host must also set textDescriptor. On read: Set by plug-in to describe the text, only valid if isTextLayer is true On write: Set by host to describe the text, only valid if isTextLayer is true.
On read: Set by plug-in to tell that this is a divider On write: Set by host to indicate that this is a group divider If true the type is either start or end, see isGroupStart.
On read: Set by plug-in to tell that this is a group start layer (true) or end (false) On write: Set by host to indicate that this is a group start layer (true) or end (false) Only valid if isGroupDivider is true.
On read: Set by plug-in to tell that this is a visible layer On write: Set by host to indicate that this is a visible layer.
On read: Set by plug-in to tell that this is a locked layer On write: Set by host to indicate that this is a locked layer.
Layer blend mode, as 4 character keys.
Layer opacity; range from 0 to 255, where opaque = 255.
Handle that may be allocated by bulkSettings/blukOpen call. Should be freed by host after processing the bulk results.
Unicode, cross-platform-friendly file specification This is an array when using the formatSelectorBulkSettings. Indicates whether the host supports POSIX file IO plug-in API. Indicates whether the plug-in is using the POSIX file IO fields; set to nonzero by the plug-in if it is. POSIX file descriptor from an open call by Photoshop; for reading and writing. Indicates whether the host is letting the plug-in open and close the file for itself. The dataFork, rsrcFork, and posixFileDescriptor fields are undefined. Set by host to true before a formatSelectorReadStart call to let plug-in know the pluginWantsSingleOpenToBulkSwitch field is supported. Set by plug-in during a formatSelectorReadStart call telling the host to process the results as if the host had called formatSelectorBulkSettings instead.
Reserved for future use. Set to zero. The documentation for this struct was generated from the following file: |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||