VRay SDK for C++
Loading...
Searching...
No Matches
VRay::LocalBmp Class Reference
Inheritance diagram for VRay::LocalBmp:
VRay::CompressImage

Public Member Functions

 LocalBmp (const VRayImage *img, bool preserveAlpha=false, bool swapChannels=false)
 
 LocalBmp (const VRayImage *img, const VRayRenderer &renderer, bool preserveAlpha=false, bool swapChannels=false)
 Same as the other constructor. The renderer is used to log error messages.
 
- Public Member Functions inherited from VRay::CompressImage
void * getBuf () const
 Returns a pointer to the image data.
 
size_t getLen () const
 Returns size of image data in bytes.
 
 operator size_t () const
 
bool saveToFile (const char *fileName) const
 Write the data to disk.
 
bool saveToFile (const std::string &fileName) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void swap (CompressImage &ci)
 

Additional Inherited Members

- Protected Attributes inherited from VRay::CompressImage
byte * bufAddr
 
size_t bufSize
 

Constructor & Destructor Documentation

◆ LocalBmp()

VRay::LocalBmp::LocalBmp ( const VRayImage img,
bool  preserveAlpha = false,
bool  swapChannels = false 
)
inline

Constructs a BMP format image in memory. This format does not compress image data.

Parameters
imgThe source image to compress. The source is not modified.
preserveAlphaYou need to set this explicitly to true to keep the alpha channel in the BMP
swapChannelsIf set to true, channel order will be BGR instead of RGB

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