HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
IMG_PSD Class Reference

#include <IMG_FilePSD.h>

+ Inheritance diagram for IMG_PSD:

Public Member Functions

 IMG_PSD ()
 
 ~IMG_PSD ()
 
virtual const char * className () const
 
virtual int open ()
 Opens a .psd type file to prepare for reading. More...
 
virtual int readScanline (int y, void *buf)
 Reads a single scanline for given row y into the buffer buf. A scanline is all the image data required to draw a single row. More...
 
virtual int create (const IMG_Stat &stat)
 
virtual int writeScanline (int scan, const void *buf)
 
virtual int closeFile ()
 Flushes any open buffers, and releases all allocated memory. Gets called by the destructor to do any cleanup. More...
 
const UT_Array
< IMG_PSDLayerRecords > & 
getRawLayerRecords ()
 
UT_Array< intgetTreeLevelsFromRawLayerRecords ()
 
- Public Member Functions inherited from IMG_File
virtual ~IMG_File ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
int close ()
 
int getReadMode () const
 Returns 1 if we are reading, 0 if writing. More...
 
virtual void getAdditionalInfo (UT_String &text)
 
const char * getOption (const char *name) const
 
const voidread (int scan, const IMG_Plane *from_plane=nullptr)
 read a single scanline. read() returns a pointer to the scanline data in an internal buffer. Do not delete it. More...
 
bool readIntoBuffer (int scan, void *buffer, const IMG_Plane *from_plane=nullptr)
 Reads the scanline into a buffer that you supply. The buffer passed must be big enough to fit the plane passed. getStat().bytesPerPlaneScan() will return the proper size. Returns 0 on failure. More...
 
bool write (int scan, const void *data, const IMG_Plane *to_plane=nullptr)
 Write a scanline to the file. You don't need to write scanlines in order, nor do you need to write planes in order; the data may be cached however. Returns 0 if there was an error during the write. You should immediately stop writing if a failure occurred (many formats will behave unpredictably otherwise). More...
 
voidallocScanlineBuffer () const
 
bool readImages (UT_Array< PXL_Raster * > &images, const char *scope=nullptr)
 Reads all the image data into a list of PXL_Rasters. reads the image data into a a series of rasters. The array should be empty, as this method creates and fills the rasters for you. More...
 
virtual bool jumpToFrame (int frame)
 
virtual void abortWrite ()
 
virtual void randomReadAccessRequired ()
 
virtual void checkpoint ()
 
bool hasError () const
 
virtual IMG_FileAlphaInfo getAlphaInfo (float &) const
 
IMG_FilegetUnfilteredFile ()
 returns the raw file at the top of the filter stack. More...
 
const IMG_FilegetUnfilteredFile () const
 
virtual IMG_FilegetBaseFile () const
 
bool copyImageTextureOptions (const IMG_File &src, bool clear_existing)
 Copy the texture image options from another IMG_File. More...
 
virtual UT_SharedPtr< UT_OptionsimageTextureOptions () const
 
virtual const UT_OptionsgetImageTextureOptions () const
 This method is deprecated. Please implement imageTextureOptions() More...
 
virtual void clearImageTextureOptions ()
 
virtual bool setImageTextureOptions (const UT_Options &options)
 
virtual void setWriteTag (const char *tagname, int num_values, const char *const *values)
 
bool getWorldToCamera (UT_Matrix4D &xform) const
 
bool getCameraToNDC (UT_Matrix4D &xform, int xres, int yres, bool fit_z=true) const
 
bool getWorldToNDC (UT_Matrix4D &xform, int xres, int yres, bool fit_z=true) const
 
virtual int getDeepPixelSamples (int x, int y)
 
virtual bool getDeepPixelPlaneData (int x, int y, const IMG_Plane &plane, float *data)
 
virtual bool getDeepPixelData (int x, int y, float *const *data)
 
virtual bool readDeepPixelData (int x, int y, PXL_DeepSampleList &pixel)
 Read a deep pixel. More...
 
IMG_ImageType getImageType () const
 
const IMG_FormatgetFormat () const
 
void setFormat (const IMG_Format *f)
 
const IMG_StatgetStat () const
 
IMG_StatgetStat ()
 
int getNumOptions () const
 
const char * getOptionName (int i) const
 
const char * getOptionValue (int i) const
 
bool readImage (void *data, int flip=0, int scaninc=0)
 
bool writeImage (void *data, int flip=0, int scaninc=0)
 
bool writeImages (const UT_Array< const PXL_Raster * > &imgs)
 Writes all PXL_Rasters to the image format. This method takes a raster per IMG_Plane in the stat. The data format, color model and res of the raster must match the corresponding IMG_Plane. If the format is not a deep raster format, not all images may be written. if 'freerasters' is true, it will free the rasters for you. More...
 
bool writeImages (UT_Array< PXL_Raster * > &images, bool freerasters=false)
 Writes all PXL_Rasters to the image format. This method takes a raster per IMG_Plane in the stat. The data format, color model and res of the raster must match the corresponding IMG_Plane. If the format is not a deep raster format, not all images may be written. if 'freerasters' is true, it will free the rasters for you. More...
 
virtual int isTopFirst () const
 
virtual int isLeftFirst () const
 If 0, scanlines are right-to-left. Default is 1 (left-to-right). More...
 
virtual bool readTile (const UT_InclusiveRect &tile, void *data, const IMG_Plane *plane=0)
 
virtual bool writeTile (const UT_InclusiveRect &tile, const void *data, const IMG_Plane *plane=0)
 
virtual bool writeDeepPixelData (int x, int y, const PXL_DeepSampleListPtr &pixel)
 
void selectPlanesToRead ()
 
bool isPlaneSelected (const IMG_Plane &plane) const
 

Static Public Member Functions

static void registerFormat ()
 
- Static Public Member Functions inherited from IMG_File
static IMG_Fileopen (const char *filename, const IMG_FileParms *options=nullptr, const IMG_Format *fmt=nullptr)
 Open an image file using a filename Open an image file for reading by specifying the filename and path of the file. An optional IMG_FileParms class may be passed to convert it into a specific image type (8bit, specific resolution, etc). An optional format may also be passed, which forces the library to assume the image file is of that particular format. This method returns a new IMG_File object which you read the image data from, or NULL if an error occurred. More...
 
static IMG_Fileopen (UT_IStream &is, const IMG_FileParms *options=nullptr, const IMG_Format *fmt=nullptr, int steal_stream=0, bool streamIsSeekable=true)
 Open an image file from a stream Open an image file for reading given a stream. This is useful for embedded images in a file. An optional IMG_FileParms class may be passed to convert it into a specific image type (8bit, specific resolution, etc). An optional format may also be passed, which forces the library to assume the image file is of that particular format. If 'steal_stream' is true, the image library assumes ownership of the stream and closes it when it's finished reading the file. If the stream is not seekable (cannot jump around in the file, such as with a pipe), set 'streamIsSeekable' to false. This method returns a new IMG_File object which you read the image data from, or NULL if an error occurred. More...
 
static IMG_Filecreate (const char *filename, const IMG_Stat &stat, const IMG_FileParms *options=nullptr, const IMG_Format *fmt=nullptr)
 Create a new image file Create a new image file with the pathname 'filename' according to the parameters specified in 'stat'. You can supply an optional 'options' class to translate the image before being written (scale, flip, etc). You can also specify an optional 'format' parameter to force the file to be written as a specific image format (regardless of the extension found in 'filename'). NULL may be returned if the file could not be created for any reason. More...
 
static IMG_Filecreate (std::ostream &os, const IMG_Stat &stat, const IMG_FileParms *options=nullptr, const IMG_Format *fmt=nullptr, int steal_stream=0, bool streamIsSeekable=true)
 Write an image file to an existing stream Writes a new image file to the stream 'os' according to the parameters specified in 'stat'. You can supply an optional 'options' class to translate the image before being written (scale, flip, etc). You can also specify an optional 'format' parameter to force the file to be written as a specific image format (regardless of the extension found in 'filename'). If 'steal_stream' is true, the image library assumes ownership of the stream and closes it when it's finished writing the file. If the stream is not seekable (cannot jump around in the file, such as with a pipe), set 'streamIsSeekable' to false. NULL may be returned if the file could not be created in the stream. More...
 
static bool saveRastersAsFiles (const char *filename, const IMG_SaveRastersToFilesParms &parms)
 Writes PXL_Raster's to image files. Convenience method to write images stored in PXL_Raster's to disk files. The linear_planes parameter specifies a pattern of planes which should be written to in linear space. More...
 
static bool copyToFile (const char *sourcename, const char *destname, const IMG_FileParms *options=nullptr)
 Copies an existing image file to another image file. Convenience method to copy an image file from one file to another. The image date may be altered if the formats of the two files are not the same (based on filename extension), or if an optional 'options' class is passed. More...
 
static bool copyToFileFormat (const char *sourcename, const char *formatname, UT_String *destname=nullptr, const IMG_FileParms *options=nullptr)
 
static bool copyToStream (const char *sourcename, std::ostream &deststream, const IMG_FileParms *options=nullptr, const IMG_Format *format=nullptr)
 Copies an existing image file to a stream Convenience method to copy an image file to a stream. The image data may be altered if an optional 'options' class is passed, or if the optional image 'format' parameter does not match the format of the source image file. More...
 
static IMG_DataType mapStorageOption (const char *option, bool *denormalize_flag=nullptr)
 
static int doErrors (int newDoErrors)
 
static bool saveRasterAsFile (const char *filename, const PXL_Raster *raster, const IMG_SaveRastersToFilesParms &parms)
 Writes a PXL_Raster to an image file. Convenience method to write an image stored in a PXL_Raster to a disk file. More...
 
static bool saveRasterAsFile (const char *filename, const PXL_Raster *raster, const IMG_FileParms *fparms=nullptr, const IMG_Format *format=nullptr)
 Writes a PXL_Raster to an image file. Convenience method to write an image stored in a PXL_Raster to a disk file. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IMG_File
 IMG_File ()
 
virtual int openPostMagic ()
 
virtual int openFile (const char *filename)
 
virtual const voidreadPlaneScanline (int y, const IMG_Plane &pi)
 
virtual int createFile (const char *filename, const IMG_Stat &stat)
 
virtual int writePlaneScanline (const void *data, int y, const IMG_Plane &pi)
 
virtual void postCloseAction ()
 
virtual bool isPassThrough () const
 
IMG_FilemakeReadFilters (const IMG_FileParms &parms)
 
IMG_FilemakeWriteFilters (const IMG_FileParms &parms)
 
virtual void computeCommonData ()
 
voidgetScanlineBuffer (int y)
 
voidgetPlaneBuffer (int y, const IMG_Plane &pi)
 
virtual void finishedScanline (int scan)
 
bool canWriteStatWithoutConversion () const
 
int peekByte ()
 
int readSomeBytes (void *buffer, int size)
 
int writeSomeBytes (const void *buffer, int size)
 
bool flushBytes ()
 
bool readBytes (void *buffer, int size)
 
bool writeBytes (const void *buffer, int size)
 
bool readAsciiLine (UT_WorkBuffer &wbuf)
 
bool seekFromBeginning (int64 offset)
 
bool seekFromCurrent (int64 offset)
 
bool seekFromEnd (int64 offset)
 
int64 tellCurrentPosition ()
 
void copyInputToStream (std::ostream &os)
 
void deleteStream ()
 
UT_IStreamgetUTIStream ()
 
void setIStream (UT_IStream *is)
 
int setOption (const char *token, const char *value)
 
int setOption (const char *token, fpreal64 val)
 
int setOption (const char *token, int64 val)
 
int setOption (const char *option, int value)
 
- Static Protected Member Functions inherited from IMG_File
static void imgError (int code, const char *msg=nullptr)
 
static void imgWarning (int code, const char *msg=nullptr)
 
static void setOptions (const IMG_FileParms *options, IMG_File *file)
 
- Protected Attributes inherited from IMG_File
IMG_Stat myStat
 
bool myReadMode
 
std::ostream * myOS
 
int64 myStreamStartPos
 
int64 myStreamLength
 
unsigned myCreateIStream:1
 
unsigned myCreateOStream:1
 
unsigned myForceRandomReads:1
 
unsigned myHasRandomReads:1
 
unsigned myFileOpen:1
 
unsigned myErrorFlag:1
 
unsigned myContinueOnErrorFlag:1
 

Detailed Description

Definition at line 542 of file IMG_FilePSD.h.

Constructor & Destructor Documentation

IMG_PSD::IMG_PSD ( )
IMG_PSD::~IMG_PSD ( )

Member Function Documentation

virtual const char* IMG_PSD::className ( void  ) const
inlinevirtual

Reimplemented from IMG_File.

Definition at line 550 of file IMG_FilePSD.h.

virtual int IMG_PSD::closeFile ( )
virtual

Flushes any open buffers, and releases all allocated memory. Gets called by the destructor to do any cleanup.

Implements IMG_File.

virtual int IMG_PSD::create ( const IMG_Stat stat)
virtual

Reimplemented from IMG_File.

const UT_Array<IMG_PSDLayerRecords>& IMG_PSD::getRawLayerRecords ( )
UT_Array<int> IMG_PSD::getTreeLevelsFromRawLayerRecords ( )
virtual int IMG_PSD::open ( )
virtual

Opens a .psd type file to prepare for reading.

Reimplemented from IMG_File.

virtual int IMG_PSD::readScanline ( int  y,
void buf 
)
virtual

Reads a single scanline for given row y into the buffer buf. A scanline is all the image data required to draw a single row.

Parameters
[in]yRow number to be read starting ranging from 0 to the images height - 1 (inclusive).
[out]bufBuffer where the image data needs to be passed into

Implements IMG_File.

static void IMG_PSD::registerFormat ( )
static
virtual int IMG_PSD::writeScanline ( int  scan,
const void buf 
)
virtual

Implements IMG_File.


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