- Main Page
- Modules
- Classes
- Files

# Decode

## Functions

bool | CxImage::LoadResource (HRSRC hRes, uint32_t imagetype, HMODULE hModule=NULL)
bool | CxImage::Load (const TCHAR *filename, uint32_t imagetype=0)
bool | CxImage::Decode (FILE *hFile, uint32_t imagetype)
bool | CxImage::Decode (CxFile *hFile, uint32_t imagetype)
bool | CxImage::Decode (uint8_t *buffer, uint32_t size, uint32_t imagetype)
bool | CxImage::CheckFormat (CxFile *hFile, uint32_t imagetype=0)
bool | CxImage::CheckFormat (uint8_t *buffer, uint32_t size, uint32_t imagetype=0)

## Detailed Description

## Function Documentation

bool CxImage::CheckFormat | ( | uint8_t * | buffer,
|  | uint32_t | size,
|  | uint32_t | imagetype = `0` |
| ) |  |  | `[inherited]`

bool CxImage::CheckFormat | ( | CxFile * | hFile,
|  | uint32_t | imagetype = `0` |
| ) |  |  | `[inherited]`

Loads an image from CxFile object

Parameters:

  | hFile,: | file handle (CxMemFile or CxIOFile), with read access.
  | imagetype,: | file format, default = 0 (CXIMAGE_FORMAT_UNKNOWN)

Returns:
  : if imagetype is not 0, the function returns true when imagetype matches the file image format. If imagetype is 0, the function returns true when the file image format is recognized as a supported format. If the returned value is true, use GetHeight(), GetWidth() or GetType() to retrieve the basic image information.

See also:
  ENUM_CXIMAGE_FORMATS

bool CxImage::Decode | ( | uint8_t * | buffer,
|  | uint32_t | size,
|  | uint32_t | imagetype |
| ) |  |  | `[inherited]`

Loads an image from memory buffer

Parameters:

  | buffer,: | memory buffer
  | size,: | size of buffer
  | imagetype,: | file format, see ENUM_CXIMAGE_FORMATS

Returns:
  true if everything is ok

bool CxImage::Decode | ( | CxFile * | hFile,
|  | uint32_t | imagetype |
| ) |  |  | `[inherited]`

Loads an image from CxFile object

Parameters:

  | hFile,: | file handle (CxMemFile or CxIOFile), with read access.
  | imagetype,: | file format, see ENUM_CXIMAGE_FORMATS

Returns:
  true if everything is ok

See also:
  ENUM_CXIMAGE_FORMATS

bool CxImage::Decode | ( | FILE * | hFile,
|  | uint32_t | imagetype |
| ) |  |  | `[inherited]`

Loads an image from file handle.

Parameters:

  | hFile,: | file handle, with read access.
  | imagetype,: | file format, see ENUM_CXIMAGE_FORMATS

Returns:
  true if everything is ok

bool CxImage::Load | ( | const TCHAR * | filename,
|  | uint32_t | imagetype = `0` |
| ) |  |  | `[inherited]`

Reads from disk the image in a specific format.

- If decoding fails using the specified image format, the function will try the automatic file format recognition.

Parameters:

  | filename,: | file name
  | imagetype,: | file format, see ENUM_CXIMAGE_FORMATS

Returns:
  true if everything is ok

bool CxImage::LoadResource | ( | HRSRC | hRes,
|  | uint32_t | imagetype,
|  | HMODULE | hModule = `NULL` |
| ) |  |  | `[inherited]`

Loads an image from the application resources.

Parameters:

  | hRes,: | the resource handle returned by FindResource().
  | imagetype,: | file format, see ENUM_CXIMAGE_FORMATS.
  | hModule,: | NULL for internal resource, or external application/DLL hinstance returned by LoadLibray.

Returns:
  true if everything is ok