SbRasterImage.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. OGNIER (Jun 2003)
**=======================================================================*/
 
#ifndef _SBRASTERIMAGE_
#define _SBRASTERIMAGE_
 
 
#include <SoDeprecationRules.h>
#include <Inventor/SbLinear.h>
#include <Inventor/sys/SoGLType.h>
#include <Inventor/SbDataType.h>
#include <Inventor/devices/SoBufferObject.h>
#include <Inventor/devices/SoCpuBufferObject.h>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class  SbRasterImage {
 
 
public:
 
  enum Components {
    UNKNOWN = -1,
    
    LUMINANCE = 1,
 
    LUMINANCE_TRANSPARENCY = 2,
 
    RGB = 3, // The default
    
    RGB_TRANSPARENCY = 4,
 
    RGBE = 5
  };
 
 
  enum CopyPolicy {
    COPY = 0,
    NO_COPY = 1,
    NO_COPY_AND_DELETE = 2,
    NO_COPY_AND_FREE = 3
  };
 
 
  SbRasterImage();
 
  SbRasterImage( const SbVec2i32 &size, Components components,
                 SoBufferObject* bufferObject );
 
  virtual ~SbRasterImage();
 
  void setSize(const SbVec2s& size);
 
  void setSize_i32(const SbVec2i32& size);
 
  SbVec2s getSize() const;
 
  SbVec2i32 getSize_i32() const;
 
  void setComponents(SbRasterImage::Components comp);
 
  SbRasterImage::Components getComponents() const;
 
  int getComponentsSize() const;
 
  int getComponentsCount() const;
 
  void setBuffer(SoBufferObject* bufferObject);
  
  SoBufferObject* getBufferObject() const;
 
  int getNumMipmaps() {return m_numMipmaps;};
 
  CopyPolicy getCopyPolicy() const;
 
  SbBool removeAlphaChannel();
 
#if 1             SoDEPRECATED
  SbRasterImage( const SbVec2s &size, Components components,
                 const unsigned char *bytes, CopyPolicy copy=COPY );SoDEPRECATED
  SbRasterImage( const SbVec2i32 &size, Components components,
                 const unsigned char *bytes, CopyPolicy copy=COPY );
SoDEPRECATED
  void setBuffer(unsigned char* buffer, CopyPolicy copy = COPY);
  SoDEPRECATED
  unsigned char* getBuffer() const;
 
#endif 
private:
 
#if 1             SoDEPRECATED
  SbRasterImage( const SbVec2i32 &size, Components components, SbDataType::DataType dataType,
                 const void *bytes, CopyPolicy copy=COPY );
 
#endif 
  SbRasterImage( const SbVec2i32 &size, Components components, SbDataType::DataType dataType,
                 SoBufferObject* bufferObject );
 
 
  void setNumMipmaps(int nmm) {m_numMipmaps = nmm;};
 
  void setDataType(SbDataType::DataType dataType) {m_dataType = dataType;};
  SbDataType::DataType getDataType() const
  {
    return m_dataType;
  }
 
  void setCompressedInternalFormat(uint8_t intFormat) {m_compressedInternalFormat = intFormat;};
  uint8_t getCompressedInternalFormat() const
  {
    return m_compressedInternalFormat;
  }
 
  /*
  * Copy a sub image inside this image at the given position.
  * If the the size of the sub image exceeds this image, only the part that fits will be copied.
  */
  bool copy(const SbRasterImage& subimage, const SbVec2i32& destPos = SbVec2i32(0, 0));
  /*
  * Copy a a portion of a sub image inside this image at the given position.
  * If the the portion exceeds this image, only the part that fits will be copied.
  */
  bool copy(const SbRasterImage& subimage, const SbVec2i32& destPos, const SbVec2i32& sourcePos, const SbVec2i32& sourceSize);
 
private:
  
  int getDataTypeSizeInBytes() const;
 
private:
 
  void commonConstructor( const SbVec2i32 &size, Components components, SbDataType::DataType dataType,
                 SoBufferObject* bufferObject );
 
  SbVec2i32 m_size;
  Components m_components;
  mutable unsigned char* m_buffer;
  SoRef<SoBufferObject> m_bufferObject;
  mutable SoRef<SoCpuBufferObject> m_cpuBufferObject;
  CopyPolicy m_copy;
  int m_numMipmaps;
  uint8_t m_compressedInternalFormat;
 
  SbDataType::DataType m_dataType;
};
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
inline SbRasterImage::CopyPolicy 
SbRasterImage::getCopyPolicy() const
{
  return m_copy;
}
 
#endif