5. Function reference

■ Function reference

"File I / O" module

• scvCheckFileFormat
• scvGetFileImageSize
• scvGetFileImageDepth
• scvGetFileImageBits
• scvPutFileImageBits
• scvBeginCatalogSave
• scvEndCatalogSave

"Effects" module

• scvEffectImageBits
• scvBeginEffect
• scvEndEffect

---

scvCheckFileFormat	Function list

function:

Check the format of the specified file.

Format:

BOOL WINAPI scvCheckFileFormat (LPSTR libDLL, LPSTR filename);

Return value:

BOOL type (whether it matches the format)

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Specified file name

What the user does:

Open the file, check the format, and close it.
Returns "TRUE" if it matches the desired format, "FALSE" otherwise.

---

scvGetFileImageSize	Function list

function:

Register the vertical and horizontal size of the specified file.

Format:

void WINAPI scvGetFileImageSize (LPSTR libDLL, LPSTR filename, LPSTR hsize, LPSTR vsize);

Return value:

none.

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Specified file name
LPSTR hsize	: Horizontal size pointer of the image.
LPSTR vsize	: Vertical pointer of the image.

What the user does:

Open the file, check the vertical and horizontal sizes, and then close it.
Set the horizontal size of long type to the hsize pointer.
vsize Set the vertical size of long type to the pointer.

---

scvGetFileImageDepth	Function list

function:

Register the color depth of the specified file.

Format:

long WINAPI scvGetFileImageDepth (LPSTR libDLL, LPSTR filename);

Return value:

Long type color depth

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Specified file name

What the user does:

Open the file, check the color depth, and close it.
The color depth (bit) is returned as 1, 4, 8, 16, 24 (32).

---

scvGetFileImageBits	Function list

function:

Register the bitmap of the specified file.

Format:

int WINAPI scvGetFileImageBits (LPSTR libDLL, LPSTR filename, LPSTR buff);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Specified file name
LPSTR buff	: Memory for registering bitmaps

What the user does:

Open the file and set the bitmap data in memory.
When finished, close the file and return 0.
If an error occurs on the way, a non-zero value is returned.

remarks:

The bitmap memory of the registration destination is secured in a continuous area of "horizontal x vertical x color depth (bit)", but the format differs slightly depending on the color depth.

---

scvPutFileImageBits	Function list

function:

Save the bitmap in the specified file.

Format:

int WINAPI scvPutFileImageBits (LPSTR libDLL, LPSTR filename, LPSTR buff, LPSTR hs, LPSTR vs, LPSTR depth);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Specified file name
LPSTR buff	: Memory where bitmap is registered
LPSTR hs	: Horizontal size pointer of the image.
LPSTR vs	: Vertical pointer of the image.
LPSTR depth	: Pointer for the color depth of the image.

What the user does:

The hs / vs / depth pointer is cast to a long pointer and the value is retrieved.
Open the file, browse the bitmap memory and write out the information you need.
When finished, close the file and return 0.
If an error occurs on the way, a non-zero value is returned.

remarks:

The bitmap memory of the registration destination is secured in a continuous area of "horizontal x vertical x color depth (bit)", but the format differs slightly depending on the color depth.

---

scvBeginCatalogSave	Function list

function:

Called before the catalog save process loop.

Format:

int WINAPI scvBeginCatalogSave (LPSTR libDLL, LPSTR filename, LPSTR num);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Character string (file name) entered in the save dialog
LPSTR num	: A pointer to the number of registered catalogs.

What the user does:

Normally, it returns 0 without doing anything.
It is used when you want to save the data registered in the catalog in one file.

---

scvEndCatalogSave	Function list

function:

Called after a loop of catalog save processing.

Format:

int WINAPI scvEndCatalogSave (LPSTR libDLL, LPSTR filename);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL	: DLL instance handle
LPSTR filename	: Character string (file name) entered in the save dialog

What the user does:

Normally, it returns 0 without doing anything.

---

scvEffectImageBits	Function list

function:

Apply effect processing to the bitmap.

Format:

int WINAPI scvEffectImageBits (LPSTR libDLL, LPSTR buff, LPSTR hs, LPSTR vs, LPSTR depth)

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL	: DLL instance handle
LPSTR buff	: Memory where bitmap is registered
LPSTR hs	: Horizontal size pointer of the image.
LPSTR vs	: Vertical pointer of the image.
LPSTR depth	: Pointer for the color depth of the image.

What the user does:

The hs / vs / depth pointer is cast to a long pointer and the value is retrieved.
Perform the required effect processing by referring to the bitmap memory.
Returns 0 when finished. If an error occurs on the way, a non-zero value is returned.

remarks:

The bitmap memory of the registration destination is secured in a continuous area of "horizontal x vertical x color depth (bit)", but the format differs slightly depending on the color depth.

---

scvBegineEffect	Function list

function:

Called before effect processing.

Format:

int WINAPI scvBeginEffect (LPSTR libDLL);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL

: DLL instance handle

What the user does:

Normally, it returns 0 without doing anything.

---

scvEndEffect	Function list

function:

Called after effect processing.

Format:

int WINAPI scvEndEffect (LPSTR libDLL);

Return value:

In case of normal termination	: 0 (zero)
In case of error	: Other values

argument:

LPSTR libDLL

: DLL instance handle

What the user does:

Normally, it returns 0 without doing anything.

---

▲ Back ｜ ■

---

★ Graphic Tools Guide ★ SEGA CONVERTER User's Manual

---

Copyright SEGA ENTERPRISES, LTD ,. 1997