Actions

Difference between revisions of "Write"

From XnView Wiki
 
(7 intermediate revisions by 2 users not shown)
Line 3: Line 3:
The gflGetDefaultSaveParams function sets the [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure with default values. To use before call of gflSaveBitmap.  
The gflGetDefaultSaveParams function sets the [[#GFL_SAVE_PARAMS|GFL_SAVE_PARAMS]] structure with default values. To use before call of gflSaveBitmap.  


  void gflGetDefaultSaveParams(
  void <b>gflGetDefaultSaveParams</b>(
&nbsp;GFL_SAVE_PARAMS* save_params
  GFL_SAVE_PARAMS* save_params
  );
  );


Line 20: Line 20:
The gflSaveBitmap function save a picture in memory into a file.  
The gflSaveBitmap function save a picture in memory into a file.  


  GFL_ERROR gflSaveBitmap(
  GFL_ERROR <b>gflSaveBitmap</b>(
&nbsp;char* filename,   
  char* filename,   
&nbsp;const GFL_BITMAP* bitmap,   
  const GFL_BITMAP* bitmap,   
&nbsp;GFL_SAVE_PARAMS* params,   
  const GFL_SAVE_PARAMS* params,   
  );
  );


Line 38: Line 38:
'''Return value'''
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].  
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].  
'''Remark'''
:gflSaveBitmapW exists for the windows unicode version of GFLSDK


'''See also'''
'''See also'''
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]], [[#gflSaveBitmapIntoHandle|gflSaveBitmapIntoHandle]]
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]], [[#gflSaveBitmapIntoHandle|gflSaveBitmapIntoHandle]]


== gflSaveBitmapIntoMemory ==
== gflSaveBitmapIntoMemory ==


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


  GFL_ERROR gflSaveBitmapIntoMemory (
  GFL_ERROR <b>gflSaveBitmapIntoMemory</b>(
&nbsp;GFL_UINT8** data,  
  GFL_UINT8** data,  
&nbsp;GFL_UINT32* data_length,  
  GFL_UINT32* data_length,  
&nbsp;const GFL_BITMAP* bitmap,   
  const GFL_BITMAP* bitmap,   
&nbsp;GFL_SAVE_PARAMS* params,   
  const GFL_SAVE_PARAMS* params,   
  );
  );


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


  GFL_ERROR gflSaveBitmapIntoHandle(
  GFL_ERROR <b>gflSaveBitmapIntoHandle</b>(
&nbsp;GFL_HANDLE handle,   
  GFL_HANDLE handle,   
&nbsp;const GFL_BITMAP* bitmap,   
  const GFL_BITMAP* bitmap,   
&nbsp;GFL_SAVE_PARAMS* params,   
  const GFL_SAVE_PARAMS* params,   
  );
  );


Line 97: Line 99:
'''See also'''
'''See also'''
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmap|gflSaveBitmap]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]]
:[[#gflGetDefaultSaveParams|gflGetDefaultSaveParams]], [[#gflSaveBitmap|gflSaveBitmap]], [[#gflSaveBitmapIntoMemory|gflSaveBitmapIntoMemory]]


== gflFileCreate ==
== gflFileCreate ==
Line 103: Line 104:
The gflFileCreate function creates a multi-page file.  
The gflFileCreate function creates a multi-page file.  


  GFL_ERROR gflFileCreate(
  GFL_ERROR <b>gflFileCreate</b>(
&nbsp;GFL_FILE_HANDLE* handle,   
  GFL_FILE_HANDLE* handle,   
&nbsp;const char* filename,   
  const char* filename,   
&nbsp;GFL_UINT32 image_count,   
  GFL_UINT32 image_count,   
&nbsp;GFL_SAVE_PARAMS* params
  const GFL_SAVE_PARAMS* params
  );
  );


Line 127: Line 128:
'''See also'''
'''See also'''
:[[#gflFileAddPicture|gflFileAddPicture]], [[#gflFileClose |gflFileClose ]]
:[[#gflFileAddPicture|gflFileAddPicture]], [[#gflFileClose |gflFileClose ]]


== gflFileAddPicture ==
== gflFileAddPicture ==
Line 133: Line 133:
The gflFileAddPicture function add a picture to a multi-page file.  
The gflFileAddPicture function add a picture to a multi-page file.  


  GFL_ERROR gflFileAddPicture(
  GFL_ERROR <b>gflFileAddPicture(</b>
&nbsp;GFL_FILE_HANDLE  handle,   
  GFL_FILE_HANDLE  handle,   
&nbsp;const GFL_BITMAP* bitmap
  const GFL_BITMAP* bitmap
  );
  );


Line 156: Line 156:
The gflFileClose function closes a multi-page file.  
The gflFileClose function closes a multi-page file.  


  void gflFileClose(
  void <b>gflFileClose</b>(
&nbsp;GFL_FILE_HANDLE handle
  GFL_FILE_HANDLE handle
  );
  );


Line 167: Line 167:
'''See also'''
'''See also'''
:[[#gflFileCreate|gflFileCreate]], [[#gflFileAddPicture|gflFileAddPicture]]
:[[#gflFileCreate|gflFileCreate]], [[#gflFileAddPicture|gflFileAddPicture]]
[[Category: GFLSDK Reference Manual]]

Latest revision as of 18:19, 27 April 2010

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
Retrieved from "https://www.xnview.com/wiki/index.php?title=Write&oldid=377"