5. Function reference

■Function reference

"File I/O" module

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

"Effect" 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

Actions performed by the user:

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

---

scvGetFileImageSize	Function list

function:

Register the vertical and horizontal sizes 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	: Pointer to the horizontal size of the image.
LPSTR vsize	: Pointer to the vertical size of the image.

Actions performed by the user:

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

---

scvGetFileImageDepth	Function list

function:

Register the color depth of the specified file.

Format:

long WINAPI scvGetFileImageDepth(LPSTR libDLL, LPSTR filename);

Return value:

long color depth

argument:

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

Actions performed by the user:

Open the file, check the color depth, and close it.
Returns the color depth (bits) as 1, 4, 8, 16, or 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 to register bitmap

Actions performed by the user:

Open the file and set the bitmap data to memory.
When finished, close the file and return 0.
If an error occurs during the process, a value other than 0 is returned.

remarks:

The bitmap memory for registration is secured in a continuous area of "width x height x color depth (bits)", but the format differs slightly depending on the color depth.

---

scvPutFileImageBits	Function list

function:

Save the bitmap to 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 the bitmap is registered
LPSTR hs	: Pointer to the horizontal size of the image.
LPSTR vs.	: Pointer to the vertical size of the image.
LPSTR depth	: Pointer to the color depth of the image.

Actions performed by the user:

Cast the hs/vs/depth pointer to a long type pointer and extract the value.
Open the file, reference the bitmap memory, and write out the information you need.
When finished, close the file and return 0.
If an error occurs during the process, a value other than 0 is returned.

remarks:

The bitmap memory for registration is secured in a continuous area of "width x height x color depth (bits)", but the format differs slightly depending on the color depth.

---

scvBeginCatalogSave	Function list

function:

Called before the catalog save processing 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 entered in the save dialog (file name)
LPSTR num	: Pointer to the number of catalog registrations.

Actions performed by the user:

Normally it does nothing and returns 0.
This is used when you want to save cataloged data in one file.

---

scvEndCatalogSave	Function list

function:

Called after the catalog save processing loop.

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 entered in the save dialog (file name)

Actions performed by the user:

Normally it does nothing and returns 0.

---

scvEffectImageBits	Function list

function:

Apply effects to bitmaps.

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 the bitmap is registered
LPSTR hs	: Pointer to the horizontal size of the image.
LPSTR vs.	: Pointer to the vertical size of the image.
LPSTR depth	: Pointer to the color depth of the image.

Actions performed by the user:

Cast the hs/vs/depth pointer to a long type pointer and extract the value.
Performs necessary effect processing by referring to bitmap memory .
Returns 0 when finished. If an error occurs during the process, a value other than 0 is returned.

remarks:

The bitmap memory for registration is secured in a continuous area of "width x height x color depth (bits)", 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

Actions performed by the user:

Normally it does nothing and returns 0.

---

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

Actions performed by the user:

Normally it does nothing and returns 0.

---

▲ Back | ■

---

★ Graphic Tools Guide ★ SEGA CONVERTER User's Manual

---

Copyright SEGA ENTERPRISES, LTD. 1997