Actions

Difference between revisions of "Read"

From XnView Wiki
Line 3: Line 3:
The gflGetDefaultLoadParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflLoadBitmap*.  
The gflGetDefaultLoadParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflLoadBitmap*.  


  void gflGetDefaultLoadParams(
  void <b>gflGetDefaultLoadParams</b>(
&nbsp;GFL_LOAD_PARAMS* load_params
  GFL_LOAD_PARAMS* load_params
  );
  );


Line 20: Line 20:
The gflLoadBitmap function load a picture file into memory.  
The gflLoadBitmap function load a picture file into memory.  


  GFL_ERROR gflLoadBitmap(
  GFL_ERROR <b>gflLoadBitmap</b>(
&nbsp;const char* filename,   
  const char* filename,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION * informations,   
  GFL_FILE_INFORMATION * informations,   
  );
  );


Line 50: Line 50:
The gflLoadBitmapFromMemory function load a picture from memory.  
The gflLoadBitmapFromMemory function load a picture from memory.  


  GFL_ERROR gflLoadBitmapFromMemory(
  GFL_ERROR <b>gflLoadBitmapFromMemory</b>(
&nbsp;GFL_UINT8* data,   
  GFL_UINT8* data,   
&nbsp;GFL_UINT32 data_length,   
  GFL_UINT32 data_length,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION* informations,   
  );
  );


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


  GFL_ERROR gflLoadBitmapFromHandle(
  GFL_ERROR <b>gflLoadBitmapFromHandle</b>(
&nbsp;GFL_HANDLE handle,   
  GFL_HANDLE handle,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION* informations,   
  );
  );


Line 115: Line 115:
The gflGetDefaultThumbnailParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflGetDefaultThumbnail*.  
The gflGetDefaultThumbnailParams function sets the [[Structures#GFL_LOAD_PARAMS|GFL_LOAD_PARAMS]] structure with default values. Must be called before gflGetDefaultThumbnail*.  


  void gflGetDefaultThumbnailParams(
  void <b>gflGetDefaultThumbnailParams</b>(
&nbsp;GFL_LOAD_PARAMS* load_params
  GFL_LOAD_PARAMS* load_params
  );
  );


Line 132: Line 132:
The gflLoadThumbnail function load a picture file as a thumbnail into memory.  
The gflLoadThumbnail function load a picture file as a thumbnail into memory.  


  GFL_ERROR gflLoadThumbnail(
  GFL_ERROR <b>gflLoadThumbnail</b>(
&nbsp;const char* filename,   
  const char* filename,   
&nbsp;GFL_INT32 width,   
  GFL_INT32 width,   
&nbsp;GFL_INT32 height,   
  GFL_INT32 height,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION* informations,   
  );
  );


Line 169: Line 169:
The gflLoadThumbnailFromMemory function load a picture file as a thumbnail from memory.  
The gflLoadThumbnailFromMemory function load a picture file as a thumbnail from memory.  


  GFL_ERROR gflLoadThumbnailFromMemory(
  GFL_ERROR <b>gflLoadThumbnailFromMemory</b>(
&nbsp;GFL_UINT8* data,   
  GFL_UINT8* data,   
&nbsp;GFL_UINT32 data_length,   
  GFL_UINT32 data_length,   
&nbsp;GFL_INT32 width,   
  GFL_INT32 width,   
&nbsp;GFL_INT32 height,   
  GFL_INT32 height,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION* informations,   
  );
  );


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


  GFL_ERROR gflLoadThumbnailFromHandle(
  GFL_ERROR <b>gflLoadThumbnailFromHandle</b>(
&nbsp;GFL_HANDLE handle,   
  GFL_HANDLE handle,   
&nbsp;GFL_INT32 width,   
  GFL_INT32 width,   
&nbsp;GFL_INT32 height,   
  GFL_INT32 height,   
&nbsp;GFL_BITMAP** bitmap,   
  GFL_BITMAP** bitmap,   
&nbsp;GFL_LOAD_PARAMS* params,   
  GFL_LOAD_PARAMS* params,   
&nbsp;GFL_FILE_INFORMATION* informations,   
  GFL_FILE_INFORMATION* informations,   
  );
  );


Line 246: Line 246:
The gflGetFileInformation function retrieves all informations about a picture file.  
The gflGetFileInformation function retrieves all informations about a picture file.  


  GFL_ERROR gflGetFileInformation(
  GFL_ERROR <b>gflGetFileInformation</b>(
&nbsp;const char* filename,   
  const char* filename,   
&nbsp;GFL_INT32 index,   
  GFL_INT32 index,   
&nbsp;GFL_FILE_INFORMATION* information
  GFL_FILE_INFORMATION* information
  );
  );


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


  GFL_ERROR gflGetFileInformationFromMemory(
  GFL_ERROR <b>gflGetFileInformationFromMemory</b>(
&nbsp;GFL_UINT8* data,   
  GFL_UINT8* data,   
&nbsp;GFL_UINT32 data_length,   
  GFL_UINT32 data_length,   
&nbsp;GFL_INT32 index,   
  GFL_INT32 index,   
&nbsp;GFL_FILE_INFORMATION* information
  GFL_FILE_INFORMATION* information
  );
  );


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


  GFL_ERROR gflGetFileInformationFromHandle(
  GFL_ERROR <b>gflGetFileInformationFromHandle</b>(
&nbsp;GFL_HANDLE handle,   
  GFL_HANDLE handle,   
&nbsp;GFL_INT32 index,   
  GFL_INT32 index,   
&nbsp;const GFL_LOAD_CALLBACKS* callbacks,   
  const GFL_LOAD_CALLBACKS* callbacks,   
&nbsp;GFL_FILE_INFORMATION* information
  GFL_FILE_INFORMATION* information
  );
  );


Line 333: Line 333:
The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure.  
The gflFreeFileInformation function frees the content of a GFL_FILE_INFORMATION structure.  


  void gflFreeFileInformation(
  void <b>gflFreeFileInformation</b>(
&nbsp;GFL_FILE_INFORMATION* information
  GFL_FILE_INFORMATION* information
  );
  );


Revision as of 13:15, 23 September 2009

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 load a picture file into memory. 

GFL_ERROR gflLoadBitmap(
  const char* filename,  
  GFL_BITMAP** bitmap,  
  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.

See also

gflGetDefaultLoadParams, gflLoadBitmapFromMemory, gflLoadBitmapFromHandle


gflLoadBitmapFromMemory

The gflLoadBitmapFromMemory function load a picture from memory. 

GFL_ERROR gflLoadBitmapFromMemory(
  GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_BITMAP** bitmap,  
  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 load a picture into memory with the use of read callback functions. 

GFL_ERROR gflLoadBitmapFromHandle(
  GFL_HANDLE handle,  
  GFL_BITMAP** bitmap,  
  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 load a picture file as a thumbnail into memory. 

GFL_ERROR gflLoadThumbnail(
  const char* filename,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  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.

See also

gflGetDefaultThumbnailParams, gflLoadThumbnailFromHandle, gflLoadThumbnailFromMemory


gflLoadThumbnailFromMemory

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

GFL_ERROR gflLoadThumbnailFromMemory(
  GFL_UINT8* data,  
  GFL_UINT32 data_length,  
  GFL_INT32 width,  
  GFL_INT32 height,  
  GFL_BITMAP** bitmap,  
  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 load 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,  
  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.

See also

gflGetFileInformationFromMemory, gflGetFileInformationFromHandle


gflGetFileInformationFromMemory

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

GFL_ERROR gflGetFileInformationFromMemory(
  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
Callback 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

bitmap
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=162"