Actions

Difference between revisions of "Read"

From XnView Wiki
 
(4 intermediate revisions by one other user not shown)
Line 83: Line 83:
== gflLoadBitmapFromHandle ==
== gflLoadBitmapFromHandle ==


The gflLoadBitmapFromHandle function load a picture into memory with the use of read callback functions.  
The gflLoadBitmapFromHandle function loads a picture into memory with the use of read callback functions.  


  GFL_ERROR <b>gflLoadBitmapFromHandle</b>(
  GFL_ERROR <b>gflLoadBitmapFromHandle</b>(
Line 130: Line 130:
== gflLoadThumbnail ==
== gflLoadThumbnail ==


The gflLoadThumbnail function load a picture file as a thumbnail into memory.  
The gflLoadThumbnail function loads a picture file as a thumbnail into memory.  


  GFL_ERROR <b>gflLoadThumbnail</b>(
  GFL_ERROR <b>gflLoadThumbnail</b>(
Line 169: Line 169:
== gflLoadThumbnailFromMemory ==
== gflLoadThumbnailFromMemory ==


The gflLoadThumbnailFromMemory function load a picture file as a thumbnail from memory.  
The gflLoadThumbnailFromMemory function loads a picture file as a thumbnail from memory.  


  GFL_ERROR <b>gflLoadThumbnailFromMemory</b>(
  GFL_ERROR <b>gflLoadThumbnailFromMemory</b>(
Line 208: Line 208:
== gflLoadThumbnailFromHandle ==
== gflLoadThumbnailFromHandle ==


The gflLoadThumbnailFromHandle function load a picture file as a thumbnail into memory with the use of read callback functions.  
The gflLoadThumbnailFromHandle function loads a picture file as a thumbnail into memory with the use of read callback functions.  


  GFL_ERROR <b>gflLoadThumbnailFromHandle</b>(
  GFL_ERROR <b>gflLoadThumbnailFromHandle</b>(
Line 344: Line 344:
'''See also'''
'''See also'''
:[[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]], [[#gflGetFileInformation|gflGetFileInformation]], [[#gflGetFileInformationFromHandle|gflGetFileInformationFromHandle]], [[#gflGetFileInformationFromMemory|gflGetFileInformationFromMemory]]
:[[#gflLoadBitmap|gflLoadBitmap]], [[#gflLoadBitmapFromMemory|gflLoadBitmapFromMemory]], [[#gflLoadBitmapFromHandle|gflLoadBitmapFromHandle]], [[#gflGetFileInformation|gflGetFileInformation]], [[#gflGetFileInformationFromHandle|gflGetFileInformationFromHandle]], [[#gflGetFileInformationFromMemory|gflGetFileInformationFromMemory]]
[[Category: GFLSDK Reference Manual]]

Latest revision as of 18:19, 27 April 2010

gflGetDefaultLoadParams

The gflGetDefaultLoadParams function sets the GFL_LOAD_PARAMS structure with default values. Must be called before gflLoadBitmap*. 

void gflGetDefaultLoadParams(
  GFL_LOAD_PARAMS* load_params
);

Parameters

load_params
Pointer to a GFL_LOAD_PARAMS structure.

See also

gflGetDefaultThumbnailParams, gflLoadBitmap, gflLoadBitmapFromHandle, gflLoadBitmapFromMemory


gflLoadBitmap

The gflLoadBitmap function loads a picture file into memory. 

GFL_ERROR gflLoadBitmap(
  const char* filename,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION * informations
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to load.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

Remark

gflLoadBitmapW exists for the windows unicode version of GFLSDK

See also

gflGetDefaultLoadParams, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle

gflLoadBitmapFromMemory

The gflLoadBitmapFromMemory function loads a picture from memory. 

GFL_ERROR gflLoadBitmapFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetDefaultLoadParams, gflLoadBitmap, gflLoadBitmapFromHandle

gflLoadBitmapFromHandle

The gflLoadBitmapFromHandle function loads a picture into memory with the use of read callback functions. 

GFL_ERROR gflLoadBitmapFromHandle(
  GFL_HANDLE handle,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

handle
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetDefaultLoadParams, gflLoadBitmap, gflLoadBitmapFromMemory

gflGetDefaultThumbnailParams

The gflGetDefaultThumbnailParams function sets the GFL_LOAD_PARAMS structure with default values. Must be called before gflGetDefaultThumbnail*. 

void gflGetDefaultThumbnailParams(
  GFL_LOAD_PARAMS* load_params
);

Parameters

load_params
Pointer to a GFL_LOAD_PARAMS structure.

See also

gflGetDefaultLoadParams, gflLoadThumbnail, gflLoadThumbnailFromHandle, gflLoadThumbnailFromMemory


gflLoadThumbnail

The gflLoadThumbnail function loads a picture file as a thumbnail into memory. 

GFL_ERROR gflLoadThumbnail(
  const char* filename,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to load.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

Remark

gflLoadThumbnailW exists for the windows unicode version of GFLSDK

See also

gflGetDefaultThumbnailParams, gflLoadThumbnailFromHandle, gflLoadThumbnailFromMemory

gflLoadThumbnailFromMemory

The gflLoadThumbnailFromMemory function loads a picture file as a thumbnail from memory. 

GFL_ERROR gflLoadThumbnailFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetDefaultThumbnailParams, gflLoadThumbnail, gflLoadThumbnailFromHandle

gflLoadThumbnailFromHandle

The gflLoadThumbnailFromHandle function loads a picture file as a thumbnail into memory with the use of read callback functions. 

GFL_ERROR gflLoadThumbnailFromHandle(
  GFL_HANDLE handle,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  const GFL_LOAD_PARAMS* params,  
  GFL_FILE_INFORMATION* informations,  
);

Parameters

handle
User handle. The Callbacks field of the GFL_LOAD_PARAMS structure must be filled correctly.
width
Width of the thumbnail.
height
Height of the thumbnail.
bitmap
Address of a pointer to a GFL_BITMAP structure.
params
Pointer to a GFL_LOAD_PARAMS structure.
This structure must be filled correctly.
informations
Pointer to a GFL_FILE_INFORMATION structure. Can be NULL if you don't want it.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetDefaultThumbnailParams, gflLoadThumbnail, gflLoadThumbnailFromMemory

gflGetFileInformation

The gflGetFileInformation function retrieves all informations about a picture file. 

GFL_ERROR gflGetFileInformation(
  const char* filename,  
  GFL_INT32 index,  
  GFL_FILE_INFORMATION* information
);

Parameters

filename
Pointer to a null-terminated string that contains the filename.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

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

Remark

gflGetFileInformationW exists for the windows unicode version of GFLSDK

See also

gflGetFileInformationFromMemory, gflGetFileInformationFromHandle

gflGetFileInformationFromMemory

The gflGetFileInformationFromMemory function retrieves all informations about a picture from memory. 

GFL_ERROR gflGetFileInformationFromMemory(
  const GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_INT32 index,  
  GFL_FILE_INFORMATION* information
);

Parameters

data
Pointer to the picture.
data_length
Length of data.
index
Index of format. -1 for automatic recognition.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetFileInformation, gflGetFileInformationFromHandle

gflGetFileInformationFromHandle

The gflGetFileInformationFromHandle function retrieves all informations about a picture with the use of read callback functions. 

GFL_ERROR gflGetFileInformationFromHandle(
  GFL_HANDLE handle,  
  GFL_INT32 index,  
  const GFL_LOAD_CALLBACKS* callbacks,  
  GFL_FILE_INFORMATION* information
);

Parameters

handle
User handle.
index
Index of format. -1 for automatic recognition.
callbacks
Pointer to a GFL_LOAD_CALLBACKS to access picture data.
information
Pointer to a GFL_FILE_INFORMATION structure.
You must use gflFreeFileInformation to free his content.

Return value

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

See also

gflGetFileInformation, gflGetFileInformationFromMemory

gflFreeFileInformation

The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure. 

void gflFreeFileInformation(
  GFL_FILE_INFORMATION* information
);

Parameters

information
Pointer to a GFL_FILE_INFORMATION structure.

See also

gflLoadBitmap, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle, gflGetFileInformation, gflGetFileInformationFromHandle, gflGetFileInformationFromMemory
Retrieved from "https://www.xnview.com/wiki/index.php?title=Read&oldid=378"