VTFLib/VTFLib.h File Reference

VTFLib main header. More...

#include "stdafx.h"
#include "Error.h"
#include "VTFFile.h"
#include "VMTFile.h"
#include <vector>

Include dependency graph for VTFLib.h:

This graph shows which files directly or indirectly include this file:

Namespaces
namespace	VTFLib
Defines
#define	VL_VERSION   127
	VTFLib version as integer.
#define	VL_VERSION_STRING   "1.2.7"
	VTFLib version as string.
Typedefs
typedef std::vector < VTFLib::CVTFFile * >	VTFLib::CImageVector
typedef std::vector < VTFLib::CVMTFile * >	VTFLib::CMaterialVector
typedef enum tagVTFLibOption	VTFLibOption
Enumerations
enum	tagVTFLibOption {   VTFLIB_DXT_QUALITY, VTFLIB_LUMINANCE_WEIGHT_R, VTFLIB_LUMINANCE_WEIGHT_G, VTFLIB_LUMINANCE_WEIGHT_B,   VTFLIB_BLUESCREEN_MASK_R, VTFLIB_BLUESCREEN_MASK_G, VTFLIB_BLUESCREEN_MASK_B, VTFLIB_BLUESCREEN_CLEAR_R,   VTFLIB_BLUESCREEN_CLEAR_G, VTFLIB_BLUESCREEN_CLEAR_B, VTFLIB_FP16_HDR_KEY, VTFLIB_FP16_HDR_SHIFT,   VTFLIB_FP16_HDR_GAMMA, VTFLIB_UNSHARPEN_RADIUS, VTFLIB_UNSHARPEN_AMOUNT, VTFLIB_UNSHARPEN_THRESHOLD,   VTFLIB_XSHARPEN_STRENGTH, VTFLIB_XSHARPEN_THRESHOLD, VTFLIB_VMT_PARSE_MODE }
Functions
VTFLIB_API vlUInt	vlGetVersion ()
	Return the VTFLib version as an integer.
VTFLIB_API const vlChar *	vlGetVersionString ()
	Return the VTFLib version as a string.
VTFLIB_API const vlChar *	vlGetLastError ()
	Return the last error message as a string.
VTFLIB_API vlBool	vlInitialize ()
	Initialisation function.
VTFLIB_API vlVoid	vlShutdown ()
	Shutdown function.
VTFLIB_API vlBool	vlGetBoolean (VTFLibOption Option)
	Return the specified option.
VTFLIB_API vlVoid	vlSetBoolean (VTFLibOption Option, vlBool bValue)
	Set the specified option.
VTFLIB_API vlInt	vlGetInteger (VTFLibOption Option)
	Return the specified option.
VTFLIB_API vlVoid	vlSetInteger (VTFLibOption Option, vlInt iValue)
	Set the specified option.
VTFLIB_API vlSingle	vlGetFloat (VTFLibOption Option)
	Return the specified option.
VTFLIB_API vlVoid	vlSetFloat (VTFLibOption Option, vlSingle sValue)
	Set the specified option.

---

Detailed Description

VTFLib main header.

---

Define Documentation

#define VL_VERSION   127

VTFLib version as integer.

#define VL_VERSION_STRING   "1.2.7"

VTFLib version as string.

---

Typedef Documentation

typedef enum tagVTFLibOption VTFLibOption

---

Enumeration Type Documentation

enum tagVTFLibOption

Enumerator:

VTFLIB_DXT_QUALITY
VTFLIB_LUMINANCE_WEIGHT_R
VTFLIB_LUMINANCE_WEIGHT_G
VTFLIB_LUMINANCE_WEIGHT_B
VTFLIB_BLUESCREEN_MASK_R
VTFLIB_BLUESCREEN_MASK_G
VTFLIB_BLUESCREEN_MASK_B
VTFLIB_BLUESCREEN_CLEAR_R
VTFLIB_BLUESCREEN_CLEAR_G
VTFLIB_BLUESCREEN_CLEAR_B
VTFLIB_FP16_HDR_KEY
VTFLIB_FP16_HDR_SHIFT
VTFLIB_FP16_HDR_GAMMA
VTFLIB_UNSHARPEN_RADIUS
VTFLIB_UNSHARPEN_AMOUNT
VTFLIB_UNSHARPEN_THRESHOLD
VTFLIB_XSHARPEN_STRENGTH
VTFLIB_XSHARPEN_THRESHOLD
VTFLIB_VMT_PARSE_MODE

---

Function Documentation

VTFLIB_API vlBool vlGetBoolean

(

VTFLibOption

Option

)

Return the specified option.

VTFLIB_API vlSingle vlGetFloat

(

VTFLibOption

Option

)

Return the specified option.

VTFLIB_API vlInt vlGetInteger

(

VTFLibOption

Option

)

Return the specified option.

VTFLIB_API const vlChar* vlGetLastError

(

)

Return the last error message as a string.

VTFLIB_API vlUInt vlGetVersion

(

)

Return the VTFLib version as an integer.

VTFLIB_API const vlChar* vlGetVersionString

(

)

Return the VTFLib version as a string.

VTFLIB_API vlBool vlInitialize

(

)

Initialisation function.

VTFLIB_API vlVoid vlSetBoolean	(	VTFLibOption	Option,
		vlBool	bValue
	)

Set the specified option.

VTFLIB_API vlVoid vlSetFloat	(	VTFLibOption	Option,
		vlSingle	sValue
	)

Set the specified option.

VTFLIB_API vlVoid vlSetInteger	(	VTFLibOption	Option,
		vlInt	iValue
	)

Set the specified option.

VTFLIB_API vlVoid vlShutdown

(

)

Shutdown function.

---