Initialization


Functions

void * CxImage::Create (uint32_t dwWidth, uint32_t dwHeight, uint32_t wBpp, uint32_t imagetype=0)
bool CxImage::Destroy ()
bool CxImage::DestroyFrames ()
void CxImage::Clear (uint8_t bval=0)
void CxImage::Copy (const CxImage &src, bool copypixels=true, bool copyselection=true, bool copyalpha=true)
bool CxImage::Transfer (CxImage &from, bool bTransferFrames=true)
bool CxImage::CreateFromArray (uint8_t *pArray, uint32_t dwWidth, uint32_t dwHeight, uint32_t dwBitsperpixel, uint32_t dwBytesperline, bool bFlipImage)
bool CxImage::CreateFromMatrix (uint8_t **ppMatrix, uint32_t dwWidth, uint32_t dwHeight, uint32_t dwBitsperpixel, uint32_t dwBytesperline, bool bFlipImage)
void CxImage::FreeMemory (void *memblock)
uint32_t CxImage::Dump (uint8_t *dst)
uint32_t CxImage::UnDump (const uint8_t *src)
uint32_t CxImage::DumpSize ()

Detailed Description


Function Documentation

void CxImage::Clear ( uint8_t  bval = 0  )  [inherited]

Sets the image bits to the specified value

void CxImage::Copy ( const CxImage src,
bool  copypixels = true,
bool  copyselection = true,
bool  copyalpha = true 
) [inherited]

Copies the image from an exsisting source

Parameters:
src,: source image.
copypixels,: copy the pixels from the source image into the new image.
copyselection,: copy the selection from source
copyalpha,: copy the alpha channel from source

void * CxImage::Create ( uint32_t  dwWidth,
uint32_t  dwHeight,
uint32_t  wBpp,
uint32_t  imagetype = 0 
) [inherited]

Initializes or rebuilds the image.

Parameters:
dwWidth,: width
dwHeight,: height
wBpp,: bit per pixel, can be 1, 4, 8, 24
imagetype,: (optional) set the image format, see ENUM_CXIMAGE_FORMATS
Returns:
pointer to the internal pDib object; NULL if an error occurs.

bool CxImage::CreateFromArray ( uint8_t *  pArray,
uint32_t  dwWidth,
uint32_t  dwHeight,
uint32_t  dwBitsperpixel,
uint32_t  dwBytesperline,
bool  bFlipImage 
) [inherited]

Creates an image from a generic buffer

Parameters:
pArray,: source memory buffer
dwWidth,: image width
dwHeight,: image height
dwBitsperpixel,: can be 1,4,8,24,32
dwBytesperline,: line alignment, in bytes, for a single row stored in pArray
bFlipImage,: tune this parameter if the image is upsidedown
Returns:
true if everything is ok

bool CxImage::CreateFromMatrix ( uint8_t **  ppMatrix,
uint32_t  dwWidth,
uint32_t  dwHeight,
uint32_t  dwBitsperpixel,
uint32_t  dwBytesperline,
bool  bFlipImage 
) [inherited]

See also:
CreateFromArray

bool CxImage::Destroy (  )  [inherited]

Call this function to destroy image pixels, alpha channel, selection and sub layers.

Returns:
true if everything is freed, false if the image is a Ghost

bool CxImage::DestroyFrames (  )  [inherited]

uint32_t CxImage::Dump ( uint8_t *  dst  )  [inherited]

uint32_t CxImage::DumpSize (  )  [inherited]

void CxImage::FreeMemory ( void *  memblock  )  [inherited]

simply calls "if (memblock) free(memblock);". Useful when calling Encode for a memory buffer, from a DLL compiled with different memory management options. CxImage::FreeMemory will use the same memory environment used by Encode.

Author:
[livecn]

bool CxImage::Transfer ( CxImage from,
bool  bTransferFrames = true 
) [inherited]

Transfers the image from an existing source image. The source becomes empty.

Returns:
true if everything is ok

uint32_t CxImage::UnDump ( const uint8_t *  src  )  [inherited]


Generated on Fri Jan 7 21:44:32 2011 for CxImage by  doxygen 1.5.4