Write

From XnView Wiki
Jump to: navigation, search

gflGetDefaultSaveParams

The gflGetDefaultSaveParams function sets the GFL_SAVE_PARAMS structure with default values. To use before call of gflSaveBitmap.

void gflGetDefaultSaveParams(
  GFL_SAVE_PARAMS* save_params
);

Parameters

save_params
Pointer to a GFL_SAVE_PARAMS structure.

See also

gflSaveBitmap, gflSaveBitmapIntoHandle, gflSaveBitmapIntoMemory


gflSaveBitmap

The gflSaveBitmap function save a picture in memory into a file.

GFL_ERROR gflSaveBitmap(
  char* filename,  
  const GFL_BITMAP* bitmap,  
  const GFL_SAVE_PARAMS* params,  
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to save.
bitmap
Pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_SAVE_PARAMS structure.
This structure must be filled correctly, in particular the FormatIndex field.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

Remark

gflSaveBitmapW exists for the windows unicode version of GFLSDK

See also

gflGetDefaultSaveParams, gflSaveBitmapIntoMemory, gflSaveBitmapIntoHandle

gflSaveBitmapIntoMemory

The gflSaveBitmapIntoMemory function save a picture into memory.

GFL_ERROR gflSaveBitmapIntoMemory(
  GFL_UINT8** data, 
  GFL_UINT32* data_length, 
  const GFL_BITMAP* bitmap,  
  const GFL_SAVE_PARAMS* params,  
);

Parameters

data
Address of a pointer for allocated data
data_length
Pointer for the final length of data
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_SAVE_PARAMS structure.
This structure must be filled correctly, in particular the FormatIndex field.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultSaveParams, gflSaveBitmap, gflSaveBitmapIntoHandle

gflSaveBitmapIntoHandle

The gflSaveBitmapIntoHandle function save a picture in memory into a file with the use of write callback functions.

GFL_ERROR gflSaveBitmapIntoHandle(
  GFL_HANDLE handle,  
  const GFL_BITMAP* bitmap,  
  const GFL_SAVE_PARAMS* params,  
);

Parameters

handle
User handle. The Callbacks field of the GFL_SAVE_PARAMS structure must be filled correctly.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_SAVE_PARAMS structure.
This structure must be filled correctly, in particular the FormatIndex field.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflGetDefaultSaveParams, gflSaveBitmap, gflSaveBitmapIntoMemory

gflFileCreate

The gflFileCreate function creates a multi-page file.

GFL_ERROR gflFileCreate(
  GFL_FILE_HANDLE* handle,  
  const char* filename,  
  GFL_UINT32 image_count,  
  const GFL_SAVE_PARAMS* params
);

Parameters

handle
Address of an handle.
filename
Pointer to a null-terminated string that contains the filename to create.
image_count
Number of picture to be added.
params
Pointer to a GFL_SAVE_PARAMS structure.
This structure must be filled correctly.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflFileAddPicture, gflFileClose

gflFileAddPicture

The gflFileAddPicture function add a picture to a multi-page file.

GFL_ERROR gflFileAddPicture(
  GFL_FILE_HANDLE  handle,  
  const GFL_BITMAP* bitmap
);

Parameters

handle
Handle of the file.
bitmap
Pointer to a GFL_BITMAP structure. This is the picture to add.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflFileCreate, gflFileClose


gflFileClose

The gflFileClose function closes a multi-page file.

void gflFileClose(
  GFL_FILE_HANDLE handle
);

Parameters

handle
Handle of file.

See also

gflFileCreate, gflFileAddPicture