PIAcquire.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// Copyright  1993 - 2005 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE:  Adobe permits you to use, modify, and distribute this 
// file in accordance with the terms of the Adobe license agreement
// accompanying it.  If you have received this file from a source
// other than Adobe, then your use, modification, or distribution
// of it requires the prior written permission of Adobe.
//-------------------------------------------------------------------
#ifndef __PIAcquire__
#define __PIAcquire__

#if PRAGMA_ONCE
#pragma once
#endif

#include "PIActions.h"
#include "PIGeneral.h"
#include "SPBasic.h"

/* Operation selectors */


#define acquireSelectorAbout    0

#define acquireSelectorStart    1

#define acquireSelectorContinue 2


#define acquireSelectorFinish   3

#define acquireSelectorPrepare  4

#define acquireSelectorFinalize 5
 // end ingroup


/*  Error return values. The plug-in module may also return standard Macintosh
    operating system error codes, or report its own errors, in which case it
    can return any positive integer. */




#define acquireBadParameters    -30000  
#define acquireNoScanner        -30001  
#define acquireScannerProblem   -30002  


/******************************************************************************/

#if PRAGMA_STRUCT_ALIGN
#pragma options align=mac68k
#endif

typedef struct AcquireRecord
    {

    int32           serialNumber;   
    TestAbortProc   abortProc;      
    ProgressProc    progressProc;   
    int32           maxData;        
    int16           imageMode;      
    Point           imageSize;      
    int16           depth;          
    int16           planes;         
    Fixed           imageHRes;      
    Fixed           imageVRes;      
    LookUpTable     redLUT;         
    LookUpTable     greenLUT;       
    LookUpTable     blueLUT;        
    void *          data;           
    Rect            theRect;        
    int16           loPlane;        
    int16           hiPlane;        
    int16           colBytes;       
    int32           rowBytes;       
    int32           planeBytes;     
    Str255          filename;       
    int16           vRefNum;        
    Boolean         dirty;          
    OSType          hostSig;        
    HostProc        hostProc;       
    int32           hostModes;      
    PlaneMap        planeMap;       
    Boolean         canTranspose;   
    Boolean         needTranspose;  
    Handle          duotoneInfo;    
    int32           diskSpace;      
    SpaceProc       spaceProc;      
    PlugInMonitor   monitor;        
    void *          platformData;   
    BufferProcs *   bufferProcs;    
    ResourceProcs * resourceProcs;  
    ProcessEventProc processEvent;  
    Boolean         canReadBack;    
    Boolean         wantReadBack;   
    Boolean         acquireAgain;   
    Boolean         canFinalize;    
    DisplayPixelsProc displayPixels; 
    HandleProcs     *handleProcs;   
    // New in 3.0
    
    Boolean         wantFinalize;   
    char            reserved1[3];   
    ColorServicesProc colorServices; 
    AdvanceStateProc advanceState;  
    // New in 3.0.4 

    ImageServicesProcs *imageServicesProcs;
    int16           tileWidth;      
    int16           tileHeight;     
    Point           tileOrigin;     
    PropertyProcs   *propertyProcs; 
    // New in 4.0

    PIDescriptorParameters  *descriptorParameters;  
    Str255                  *errorString;           
    // New in 4.0.1

    Boolean         isFirstAlphaTransparency;   
    char            padding0;                   
    char            padding1;                   
    char            padding2;                   
    // New in 5.0 

    int32           maxValue;   
    SPBasicSuite    *sSPBasic;  
    void            *plugInRef; 
    int32           transparentIndex; 
    Handle          iCCprofileData;     
    int32           iCCprofileSize;     
    int32           canUseICCProfiles;  
    char            *pushDataSource;    
    // New in 5.5 

    int32           lutCount;           
    // New in 6.0 

    int32           convertMode;        
    // New in 8.0 

    int32       HostSupports32BitCoordinates;   
    int32       PluginUsing32BitCoordinates;    
    VPoint      imageSize32;                    
    VRect       theRect32;                      
    int64       diskSpace64;                    
    uint16      *unicodeFilename;               
    // New in 10.0 

    ChannelPortProcs *channelPortProcs;         
    ReadImageDocumentDesc *documentInfo;        
    /* Reserved Space for Expansion -- decrement when you add stuff */

    char            reserved [100];            
    }
AcquireRecord, *AcquireRecordPtr;

#if PRAGMA_STRUCT_ALIGN
#pragma options align=reset
#endif

/******************************************************************************/

#endif  // __PIAcquire_h__