HBitmap.h

Go to the documentation of this file.

// KB  12/20/2004  \Noel120\Include\SDK\HBitmap.h

#define __HBITMAP_H

#ifndef __HHASHOBJ_H
#include "HHashObj.h"
#endif

#ifndef _SMALLPDB
//*********************************************************
//** HBitmapBuffer
//*********************************************************
class PLUGINEXPORT HBitmapBuffer : public HHashObject
{
public:
   enum ChannelType
   {
       CT_UBYTE = 0,    // unsigned char (8 bit )
       CT_UINT  = 1,    // unsigned int (32 bit)
       CT_HALF  = 2,    // half (16 bit floating point)
       CT_FLOAT = 3,    // float (32 bit floating point)
       CT_NUM_CHANNELTYPE  // number of channel types
   };
   enum BufferType //Keep HBitmapBuffer up to date with this
   {
       BT_SCALAR = 0,   // One single channel buffer
       BT_RGB  = 1,     // RGB 3 channels buffer
       BT_RGBA  = 2,    // RGBA 4 channels buffer
       BT_YA  = 3,      // YA 2 channels buffer
       BT_NUM_BUFFERTYPE   // number of buffer types
   };

   void *GetChannelAt(int channum); //NAP Bitmap COME-back expose HBitmapChannel?
   void AllocateData(int mipmaplevel=0);
   const int GetWidth();
   const int GetHeight();
   BITMAPINFO   *CreateBITMAPINFO(BOOL replacealpha0withbk=FALSE, BOOL maketransparent=FALSE, RGBFloat *background=FALSE);
   HBitmapBuffer *GetNext();
   const int GetNbrChannels();
   const ChannelType GetChannelsType();
   const BufferType GetBufferType();
   const char *GetChannelNameAt(int channum);
   void SetBackground(const RGBFloat &color);
   const RGBFloat GetBackground();   
   void SetIsKeyBackground(BOOL iskeybackground);
   const BOOL GetIsKeyBackground();
   void SetGamma(float gamma);
   const float GetGamma();
   void SetIsPremultipliedAlpha(BOOL ispremultiplied);
   const BOOL GetIsPremultipliedAlpha();
   HBitmapBuffer *MakeCopy();
   HBitmapBuffer *MakeBlankCopy();
};

//*********************************************************
//** HYABuffer
//*********************************************************
class PLUGINEXPORT HYABuffer : public HBitmapBuffer
{
public:
   void *GetData(int mipmaplevel=0);
};

//*********************************************************
//** HRGBABuffer
//*********************************************************
class PLUGINEXPORT HRGBABuffer : public HBitmapBuffer
{
public:
   void *GetData(int mipmaplevel=0);
};

//*********************************************************
//** HRGBBuffer
//*********************************************************
class PLUGINEXPORT HRGBBuffer : public HBitmapBuffer
{
public:
   void *GetData(int mipmaplevel=0);
};

//*********************************************************
//** HScalarBuffer
//*********************************************************
class PLUGINEXPORT HScalarBuffer : public HBitmapBuffer
{
public:
   void *GetData(int mipmaplevel=0);
};

//*********************************************************
//** HRGBAFloatBuffer
//*********************************************************
class PLUGINEXPORT HRGBAFloatBuffer : public HRGBABuffer
{
public:
   RGBAFloat *GetRGBAFloatData(int miplevel=0);
};

//*********************************************************
//** HBitmapNode
//*********************************************************
class PLUGINEXPORT HBitmapNode : public HHashObject
{
public:
   enum LoadFlags { LOADDEFAULT = 0x0,
          LOADBKCOLOR     =0x01,
          LOADINFOONLY    =0x02,
          INITIALIZE      =0x04,
          NOMODIFIEDCHECK =0x08 };

   enum { LOAD_FAILED, LOAD_OK, ALREADY_LOADED };
   
   enum { WRITE_NORESULT  =0,
          WRITE_ERROR     =0x01,
          WRITE_OK        =0x02,
          WRITE_NEEDCLOSE =0x04 };
   const int GetWidth();
   const int GetHeight();
   void SetWidth(int width);
   void SetHeight(int height);
   HBitmapNode *ScaleBitmap(int width, int height);
   UBYTE *CreateByteBlock(int *rbytesperpixel, BOOL withborder=FALSE, BOOL *bHasTransparency=NULL);
   const LONG GetFps();
   void SetFps( LONG fps );
   const int GetLength();
   void SetLength( int length );
   void AddBuffer(HBitmapBuffer *);
   void DeleteAllBuffers();
   HBitmapBuffer *GetBufferHead();
   void ReadPixel(int x, int y, RGBFloat &color); //NAP Bitmap return error?
   void ReadPixel(int x, int y, RGBAFloat &color); 
   void ReadPixel(int x, int y, YAFloat &color); 

   int LoadFrame( const String &filename, int frame=-1, LoadFlags flags = LOADDEFAULT );
   
   static HYABuffer     *CreateYABuffer(const String &name, HBitmapBuffer::ChannelType chantype, int width, int height);
   static HRGBABuffer   *CreateRGBABuffer(const String &name, HBitmapBuffer::ChannelType chantype, int width, int height);
   static HRGBBuffer    *CreateRGBBuffer(const String &name, HBitmapBuffer::ChannelType chantype, int width, int height);
   static HScalarBuffer *CreateScalarBuffer(const String &name, HBitmapBuffer::ChannelType chantype, int width, int height);
   //prefered output of a posteffect plugin is a RGBAFloatBuffer
   static HRGBAFloatBuffer *CreateRGBAFloatBuffer(const String &name, int width, int height);
};

//*********************************************************
//** HBufferShortcut
//*********************************************************
class PLUGINEXPORT HBufferShortcut : public HHashObject
{
public:
   HRGBAFloatBuffer *GetRGBAFloatBuffer(Time time);
   HBufferShortcut  *GetNextBufferShortcut();
   void              SetBuffer(HBitmapBuffer *buffer);
   String            GetFileName();
};
#endif

---